aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorjacob janzen <53062115+JacobJanzen@users.noreply.github.com>2024-02-14 19:45:43 -0600
committerGitHub <noreply@github.com>2024-02-15 01:45:43 +0000
commit762ce2792750dfc662364372f308b03b91aa925c (patch)
tree91025d0cdfc1477c71a3d96afdc9376ebb6cdba8 /README.org
parent4c337161da57dfbab4f031220014c881c4cf1b62 (diff)
add readme; name project (#4)
Diffstat (limited to 'README.org')
-rw-r--r--README.org46
1 files changed, 46 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..e735a73
--- /dev/null
+++ b/README.org
@@ -0,0 +1,46 @@
+#+title: 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
+#+begin_src sh
+tar xzf urlg-<version>.tar.gz
+cd urlg-<version>
+./configure && make
+make install # run as root
+#+end_src
+
+and uninstalled with
+
+#+begin_src sh
+make uninstall # run as root
+#+end_src
+
+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
+
+#+begin_src sh
+autoreconf --install
+./configure
+make
+make install # run as root
+#+end_src
+
+and uninstalled with
+
+#+begin_src sh
+make uninstall # run as root
+#+end_src