mirror of https://github.com/Sam1301/Lite.git
Update README
This commit is contained in:
parent
bf05493586
commit
132f60b6d5
51
README.md
51
README.md
|
@ -1,2 +1,49 @@
|
|||
# Text-Editor
|
||||
lightweight text editor built from scratch without any dependencies
|
||||
# Lite
|
||||
Lite is a terminal based lightweight text editor built using C language.
|
||||
|
||||
## Dependencies
|
||||
Standard C libraries only
|
||||
|
||||
## Installation
|
||||
|
||||
### Clone
|
||||
Clone this repository by running the following command in a terminal:
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/Sam1301/Lite.git
|
||||
```
|
||||
|
||||
### Run
|
||||
Run the following command:
|
||||
|
||||
```bash
|
||||
$ cd Lite && ./editor
|
||||
```
|
||||
|
||||
## Supported Features
|
||||
|
||||
1) View existing files.
|
||||
|
||||
2) Edit exiting or new files creted.
|
||||
|
||||
## Help
|
||||
|
||||
| Command | Function |
|
||||
|---------|-----------|
|
||||
| Ctrl+Q | Exit |
|
||||
| Ctrl+S | Save |
|
||||
| ESC | exit mode |
|
||||
|
||||
## Issues
|
||||
|
||||
You can report the bugs at the [issue tracker](https://github.com/Sam1301/Lite/issues)
|
||||
|
||||
## License
|
||||
|
||||
The `kilo` source code contained in `steps.diff` was
|
||||
[originally written](https://github.com/antirez/kilo) by Salvatore Sanfilippo
|
||||
(aka [antirez](https://github.com/antirez)) and released under the BSD 2-clause
|
||||
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