diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f366f5e --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +st +*.o diff --git a/README b/README deleted file mode 100644 index 6a846ed..0000000 --- a/README +++ /dev/null @@ -1,34 +0,0 @@ -st - simple terminal --------------------- -st is a simple terminal emulator for X which sucks less. - - -Requirements ------------- -In order to build st you need the Xlib header files. - - -Installation ------------- -Edit config.mk to match your local setup (st is installed into -the /usr/local namespace by default). - -Afterwards enter the following command to build and install st (if -necessary as root): - - make clean install - - -Running st ----------- -If you did not install st with make clean install, you must compile -the st terminfo entry with the following command: - - tic -sx st.info - -See the man page for additional details. - -Credits -------- -Based on Aurélien APTEL bt source code. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f7ad2d --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# st - simple terminal - mike's build + +### Patch Management + +Patches are applied using [Quilt](https://savannah.nongnu.org/projects/quilt/quilt/), which is a patch manager that allows you to easily apply multiple patches, revert specific patches, etc. It makes customizing suckless projects much easier since most changes are done via patches. + +## Installation + +```sh +git clone https://git.mjwilson.org/mike/st.git +cd st +sudo make clean install +``` + +