jjanzen/urlg
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

reformat readme

Browse source
This commit is contained in:
Jacob Janzen 2024-04-12 02:15:45 +00:00
parent cf4c776004
commit 713149da3c
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -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