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..a0b54c7 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# stj +stj is my personal build of the st terminal. I use it as a ways of becoming +more familiar with the C programming language. + +# Goals +- [x] Start using CMake + * Maybe also convert the Makefile wrapper to CMake? +- [ ] split the original codebase into logical segments I can work with + * use clang-format to keep things tidy +- [ ] apply my preferred patches, using the same structure as above +- [ ] clean up the config file; make it more accessible + +# Cool ideas I want to try +- [ ] use the [tmux source code](https://github.com/tmux/tmux) to add tmux to + the terminal natively, adding only the features I use +- [ ] add a native shell? (possible the +[ion shell](https://github.com/redox-os/ion)) + +# Installing +The provided Makefile is a wrapper around CMake. It allows you to build 2 +versions: debug (the default) and release. The debug build doesn't optimize +anything, and adds the address sanitizer. + +Running `make install` will build the release version, and install it in +`/usr/local` by default. The prefix can be changed in the Makefile.