Add README.md

This commit is contained in:
EnumDev 2025-06-14 13:08:56 +03:00
parent ffd8cd54c0
commit 2d49f84d6f
3 changed files with 20 additions and 0 deletions

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# Typer Text Editor
### A simple and easy to use text editor written in Go
| Default Style | Classic Style |
|:----------------------------------------------------------------:|:----------------------------------------------------------------:|
| ![Example of the Typer's default style](media/default-style.png) | ![Example of the Typer's classic style](media/classic-style.png) |
### Installation
#### From source:
- Download `go` from your package manager or from the go website
- Downlaod `which` from your package manager
- Download `make` from your package manager
- Run the following command to compile Typer
```shell
make
```
- Run the following command **with superuser privileges** to install Typer to your system
```shell
make install SYSCONFDIR=/etc
```

BIN
media/classic-style.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

BIN
media/default-style.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB