Update README

This commit is contained in:
Saumya Bhatnagar 2018-05-31 13:23:33 +05:30
parent bf05493586
commit 132f60b6d5
1 changed files with 49 additions and 2 deletions

View File

@ -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/)