diff --git a/README.md b/README.md new file mode 100644 index 0000000..259adfd --- /dev/null +++ b/README.md @@ -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 +``` \ No newline at end of file diff --git a/media/classic-style.png b/media/classic-style.png new file mode 100644 index 0000000..b190b8e Binary files /dev/null and b/media/classic-style.png differ diff --git a/media/default-style.png b/media/default-style.png new file mode 100644 index 0000000..d739f32 Binary files /dev/null and b/media/default-style.png differ