New readme

1 files changed, 40 insertions, 3 deletions

diff --git a/README.org b/README.org
index a957a9b..01afd56 100644
--- a/README.org
+++ b/README.org
@@ -1,11 +1,48 @@
 #+TITLE: st - simple terminal
 
 * Introduction
-This is my personnal build of [[st][https://st.suckless.org/]],
+This is my personnal build of [[*st*][https://st.suckless.org/]],
 a simple terminal emulator for X which sucks less. I've applied some
-patches, added some compile flags and changed the code accordingly.
+patches, added some compile flags and fixed the code accordingly.
+
+* Depedencies
+- A C compiler
+- ~xorg~
+- ~make~
 
 * Installation
-To in
+To install this build, run these commands:
+
 #+BEGIN_SRC shell
+$ git clone git://jozanleclerc.xyz/jozan/st.git
+$ cd st
+$ make
+# make install clean
+#+END_SRC
+
+It is installed by default in the user ~/usr/local/bin~ directory but you can
+change it to something that matches more yout ~$PATH~ by editing the ~PREFIX~
+variable in ~config.mk~.
+
+* Applied patches
+You can find a list of patches and check what those I've applied are
+doing on *st*'s [[patches][https://st.suckless.org/patches/]] page.
+
+Here is my list:
+- bold is not bright
+- hidecursor
+- keyboard select
+- scrollback
+- selectioncolors
+
+* Settings
+Most settings are done by editing ~config.h~ and recompiling.
+
+** Fonts
+The default font is part of the
+[[Nerd Fonts][https://github.com/ryanoasis/nerd-fonts]] collection but can
+be changed in ~config.h:19~
 
+** Colors
+The colorscheme used in this build is ~gruvbox dark hard~, you can change it
+at ~config.h:110~.