diff options
author | Jacob Janzen <jjanzenn@proton.me> | 2024-04-09 21:05:01 -0500 |
---|---|---|
committer | Jacob Janzen <jjanzenn@proton.me> | 2024-04-09 21:05:01 -0500 |
commit | 09fb0f0445571e0c1df1243725b5a018c54ae69f (patch) | |
tree | 0aa0ef1ccf18a13467cb3c54cef1baef046b0286 /README.md | |
parent | 3cf8438856230a7c4ff89816534854427f035b4a (diff) |
move to markdown readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..54eb550 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# 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. + +## Features Implemented +- TUI interface +- Basic movement +- Procedurally generated caves +- Basic entity-component system + +## Building and Installing + +### Release Version +The application can be installed on any Unix system by downloading a release and running + +``` sh +tar xzf urlg-<version>.tar.gz +cd urlg-<version> +./configure && make +make install # run as root +``` + +and uninstalled with + +``` +make uninstall # run as root +``` + +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 + +``` sh +autoreconf --install +./configure +make +make install # run as root +``` + +and uninstalled with + +``` sh +make uninstall # run as root +``` |