From 762ce2792750dfc662364372f308b03b91aa925c Mon Sep 17 00:00:00 2001 From: jacob janzen <53062115+JacobJanzen@users.noreply.github.com> Date: Wed, 14 Feb 2024 19:45:43 -0600 Subject: add readme; name project (#4) --- .gitignore | 1 + README.org | 46 ++++++++++++++++++++++++++++++++++++++++++++++ configure.ac | 2 +- src/Makefile.am | 4 ++-- src/main.c | 4 ++++ 5 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 README.org diff --git a/.gitignore b/.gitignore index 0294c6d..686c83a 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ Makefile /src/main /stamp-h1 /*.gz +/src/urlg 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-.tar.gz +cd urlg- +./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 diff --git a/configure.ac b/configure.ac index 8e6420e..131c8a9 100644 --- a/configure.ac +++ b/configure.ac @@ -1,5 +1,5 @@ AC_PREREQ([2.65]) -AC_INIT([roguelike], [0.1], [jacob.a.s.janzen@gmail.com]) +AC_INIT([urlg], [0.0.1], [jacob.a.s.janzen@gmail.com]) AC_CONFIG_SRCDIR([src/main.c]) AC_CONFIG_AUX_DIR([build-aux]) diff --git a/src/Makefile.am b/src/Makefile.am index b6114f2..f08ba63 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,6 +1,6 @@ -bin_PROGRAMS = main +bin_PROGRAMS = urlg -main_SOURCES = \ +urlg_SOURCES = \ cavegen.c \ cavegen.h \ display.c \ diff --git a/src/main.c b/src/main.c index 086a093..758fc92 100644 --- a/src/main.c +++ b/src/main.c @@ -93,6 +93,10 @@ int main(void) display_t *disp = display_init(); + if (!disp) { + return EXIT_FAILURE; + } + // create the map struct map map; create_cave(&map); -- cgit v1.2.3