diff --git a/README.md b/README.md index 697a02a..4ab4798 100644 --- a/README.md +++ b/README.md @@ -1 +1,35 @@ -# lynx \ No newline at end of file +# lynx + + + +A basic text editor written in Rust. Lynx was made following this awesome tutorial and adding more features. + +## Current Features + +- Open/edit/save file +- Syntax Highlighting - Rust, Python support +- Warn when quitting editor without saving file + +## Todo + +- Show current line number +- Open folder +- Typescript, Javascript, TSX, JSX support + +## Run Lynx + +Make sure you have Rust, rustup, and cargo installed. You can do so here: https://www.rust-lang.org/tools/install. + +1. Clone this repository + +``` +git clone https://github.com/henryboisdequin/lynx.git +``` + +2. Run the project + +``` +cargo run +``` + +`` is the file you want to edit in Lynx. diff --git a/images/lynx.png b/images/lynx.png new file mode 100644 index 0000000..41ec22a Binary files /dev/null and b/images/lynx.png differ diff --git a/main.rs b/main.rs new file mode 100644 index 0000000..e69de29