readme

henryboisdequin · Jan 13, 2021 · b0d389d · b0d389d
1 parent d098279
commit b0d389d
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,35 @@
-# lynx
+# lynx
+
+<img src="./images/lynx.png"></img>
+
+A basic text editor written in Rust. Lynx was made <a href="https://www.philippflenker.com/hecto/">following this awesome tutorial</a> 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 <file>
+```
+
+`<file>` is the file you want to edit in Lynx.
diff --git a/images/lynx.png b/images/lynx.png
diff --git a/main.rs b/main.rs