Update README.md

2017-04-08 03:55:00 +02:00
parent a95cde8029
commit e00231e3e3
1 changed files with 42 additions and 1 deletions
@@ -1 +1,42 @@
-tte (tiny text editor) is a terminal based text editor written in C from scratch. This project is mainly created for educational purposes.
+# tte
+
+tte (tiny text editor) is a terminal based text editor written in C from scratch, trying to be very minimalistic and dependency independent. 
+
+This project was mainly created for educational purposes, so is very commented!
+
+## Installation
+
+### Compiling
+```
+git clone https://github.com/GrenderG/tte.git
+cd tte/
+make
+sudo cp tte /usr/local/bin/
+```
+
+### One liner
+```
+sudo sh -c "curl -LJO https://github.com/GrenderG/tte/releases/download/0.0.1/tte -o /usr/local/bin/tte && chmod +x /usr/local/bin/tte"
+```
+
+## Usage
+```
+tte [file_name]
+```
+
+## Keybindings
+```
+Ctrl-Q : Exit
+Ctrl-F : Search text (ESC, arrows and enter to interact once searching)
+Ctrl-S : Save
+```
+
+Current supported languages
+---------------------------
+* C (`*.c`, `*.h`)
+* C++ (`*.cpp`, `*.hpp`, `*.cc`)
+* Java (`*.java`)
+* Bash (`*.sh`)
+* Python (`*.py`)
+* PHP (`*.php`)
+* JavaScript (`*.js`, `*.jsx`)