Lite/README.md

60 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2018-06-03 04:46:48 +00:00
# :pencil2: Lite
2018-05-31 08:08:01 +00:00
2018-06-03 04:55:00 +00:00
Lite is a terminal based lightweight text editor built using only standard C libraries.
<img src="assets/lite_screenshot.png" />
2018-05-31 07:53:33 +00:00
## Dependencies
2018-06-03 04:55:00 +00:00
Standard C libraries
2018-05-31 07:53:33 +00:00
## Installation
### Clone
Clone this repository by running the following command in a terminal:
```bash
$ git clone https://github.com/Sam1301/Lite.git
```
### Run
2018-06-03 07:03:53 +00:00
Run the following commands:
2018-05-31 07:53:33 +00:00
```bash
2018-06-03 07:03:53 +00:00
$ cd Lite && make
```
```bash
$ ./Lite filename
```
To create a new file run the following command instead:
```bash
$ ./Lite
2018-05-31 07:53:33 +00:00
```
2018-06-03 04:55:00 +00:00
## How to Use
| Command | Function |
|------------------------------|--------------------|
| Ctrl+Q | Exit |
| Ctrl+S | Save |
| Ctrl+S + filename | Save As |
| Ctrl+F | Incremental Search |
| ESC | exit mode |
| :arrow_left: / :arrow_up: | search backward |
| :arrow_right: / :arrow_down: | search forward |
2018-05-31 07:53:33 +00:00
2018-06-03 04:55:00 +00:00
<br/>
<img src="assets/lite_screencast.gif" />
2018-05-31 07:53:33 +00:00
## Issues
You can report the bugs at the [issue tracker](https://github.com/Sam1301/Lite/issues)
2018-06-03 04:46:48 +00:00
## References
2018-05-31 07:53:33 +00:00
2018-06-03 04:46:48 +00:00
* [Kilo](https://github.com/antirez/kilo) written by [Salvatore Sanfilippo](https://github.com/antirez/kilo)
* [ANSI_escape_code wiki](https://en.wikipedia.org/wiki/ANSI_escape_code)
2018-06-03 07:03:53 +00:00
* [VT100 user guide](https://vt100.net/docs/vt100-ug/chapter3.html)