Skip to content

Commit bfff87b

Browse files
Update README.md
1 parent dc6fc4c commit bfff87b

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

README.md

+31-6
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,38 @@ A minimalistic text editor for terminal fanatics
66

77
## What is Editor?
88

9-
Editor is a zero-dependency text editor for the terminal. Editor is similar to other popular editors like Vim, Emacs, Nano etc. Editor is designed with the philosophy of minimalism and simplicity. It requires no external libraries (Not even [curses](https://en.wikipedia.org/wiki/Curses_(programming_library))) or dependencies for installation. It is just a single-file C program that caters all your editing needs. Editor can be compiled on any platform having GCC or the Clang C compiler. The idea behing Editor is to eliminate the key-binding complications of Vim and port the existing key-bindings of your familiar GUI based editors to CLI.
9+
Editor is a zero-dependency text editor for the terminal. Editor is similar to other popular editors like Vim, Emacs, Nano etc. Editor is designed with the philosophy of minimalism and simplicity. It requires no external libraries (Not even [curses](https://en.wikipedia.org/wiki/Curses_(programming_library))) or dependencies for installation. It is just a single-file C program that caters all your editing needs. Editor can be compiled on any platform having GCC or the Clang C compiler. The idea behing Editor is to eliminate the key-binding complications of Vim and port the existing key-bindings of your familiar GUI based editors to CLI. A statically compiled binary can allow it to run even on devices without the standard C library. This has facilitated the text editor to be used in embedded devices, routers, PoS terminals, which have very limited disk space.
1010

11+
##
1112

12-
## What can Editor do?
13+
## Features
1314

14-
Editor is currently in development mode.
15+
Editor is currently in beta mode. New features would be added in future stable releases.
16+
Editor supports:
17+
18+
- Syntax highlighting supported for over 20 programming languages
19+
- Defining your own syntax for highlighting code blocks
20+
- Incremental string searching
21+
22+
Improvements to be made in future releases:
23+
24+
- Regex pattern searching
25+
- Soft indents
26+
- Line numbers
27+
- Reading from configuration file (.rc file)
28+
- Auto indentation
29+
30+
31+
## Building from Source
32+
33+
Editor requires a standard C compiler like GCC or Clang and project building tool - [Make](https://www.gnu.org/software/make/)
34+
35+
```bash
36+
37+
build@editor$: make
38+
39+
```
40+
41+
will produce the editor binary with a single dynamically linked library - (libc.so.6 for Linux & libSystem.B.dylib for MacOS)
42+
A
1543

16-
Editor can
17-
1. Search
18-
2. Supports syntax highlighting

0 commit comments

Comments
 (0)