mirror of https://github.com/Sam1301/Lite.git
Update README.
This commit is contained in:
parent
f4bf2a5743
commit
75f5a67df8
4
Makefile
4
Makefile
|
@ -1,2 +1,2 @@
|
||||||
editor: editor.c
|
lite: lite.c
|
||||||
$(CC) editor.c -o editor -Wall -Wextra -pedantic -std=c99
|
$(CC) lite.c -o lite -Wall -Wextra -pedantic -std=c99
|
34
README.md
34
README.md
|
@ -1,4 +1,4 @@
|
||||||
<img src="logo.png">
|
# :pencil2: Lite
|
||||||
|
|
||||||
Lite is a terminal based lightweight text editor built using only C language.
|
Lite is a terminal based lightweight text editor built using only C language.
|
||||||
|
|
||||||
|
@ -21,30 +21,22 @@ Run the following command:
|
||||||
$ cd Lite && ./editor
|
$ cd Lite && ./editor
|
||||||
```
|
```
|
||||||
|
|
||||||
## Supported Features
|
## How to use
|
||||||
|
|
||||||
1) View existing files.
|
| Command | Function |
|
||||||
|
|------------------------------|-----------------|
|
||||||
2) Edit exiting or new files creted.
|
| Ctrl+Q | Exit |
|
||||||
|
| Ctrl+S | Save |
|
||||||
## Help
|
| ESC | Enter | exit mode |
|
||||||
|
| :arrow_left: | :arrow_up: | search backward |
|
||||||
| Command | Function |
|
| :arrow_right: | :arrow_down: | search forward |
|
||||||
|---------|-----------|
|
|
||||||
| Ctrl+Q | Exit |
|
|
||||||
| Ctrl+S | Save |
|
|
||||||
| ESC | exit mode |
|
|
||||||
|
|
||||||
## Issues
|
## Issues
|
||||||
|
|
||||||
You can report the bugs at the [issue tracker](https://github.com/Sam1301/Lite/issues)
|
You can report the bugs at the [issue tracker](https://github.com/Sam1301/Lite/issues)
|
||||||
|
|
||||||
## License
|
## References
|
||||||
|
|
||||||
The `kilo` source code contained in `steps.diff` was
|
* [Kilo](https://github.com/antirez/kilo) written by [Salvatore Sanfilippo](https://github.com/antirez/kilo)
|
||||||
[originally written](https://github.com/antirez/kilo) by Salvatore Sanfilippo
|
* [ANSI_escape_code wiki](https://en.wikipedia.org/wiki/ANSI_escape_code)
|
||||||
(aka [antirez](https://github.com/antirez)) and released under the BSD 2-clause
|
* [VT100 user guide](https://vt100.net/docs/vt100-ug/chapter3.html)
|
||||||
license (see `steps.diff.LICENSE`). I have made changes to the original code.
|
|
||||||
|
|
||||||
All other files in this repository are licensed under
|
|
||||||
[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
|
|
Loading…
Reference in New Issue