diff options
| author | Jacob Janzen <jjanzenn@proton.me> | 2024-04-12 02:15:45 +0000 |
|---|---|---|
| committer | Jacob Janzen <jjanzenn@proton.me> | 2024-04-11 21:20:57 -0500 |
| commit | 713149da3cb275e8b9f7ab236db6f59f8a866bcb (patch) | |
| tree | 0917b60bf7ccb58786f39868a07cc5a22b97b345 | |
| parent | cf4c776004a8f4a8a76912be2f54ae88dda1eb1f (diff) | |
reformat readme
| -rw-r--r-- | README.md | 13 |
1 files changed, 9 insertions, 4 deletions
@@ -1,7 +1,9 @@ # URLG (Untitled Rogue-Like Game) ## About -This is a simple Rogue-like game implemented in C with minimal use of libraries (only `curses` and the C standard library as of right now). It is primarily a place for me to experiment with ideas I have while procrastinating. +This is a simple Rogue-like game implemented in C with minimal use of libraries +(only `curses` and the C standard library as of right now). It is primarily a +place for me to experiment with ideas I have while procrastinating. ## Features Implemented - TUI interface @@ -12,7 +14,8 @@ This is a simple Rogue-like game implemented in C with minimal use of libraries ## Building and Installing ### Release Version -The application can be installed on any Unix system by downloading a release and running +The application can be installed on any Unix system by downloading a release and +running ``` sh tar xzf urlg-<version>.tar.gz @@ -27,13 +30,15 @@ and uninstalled with make uninstall # run as root ``` -It is only available to be installed from source. I do not distribute pre-compiled binaries. +It is only available to be installed from source. I do not distribute +pre-compiled binaries. The game can then be run as `urlg` in your terminal. ### Development Version -The development version of the software is can be installed from the =git= repository if you have GNU Autotools installed with the following commands +The development version of the software is can be installed from the =git= +repository if you have GNU Autotools installed with the following commands ``` sh autoreconf --install |