daknuett/ascii-game
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added docs

Browse Source
This commit is contained in:
Daniel Knuettel 2017-03-09 16:39:46 +01:00
parent b6b3024910
commit b4d8720b93
2 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@ -23,9 +23,10 @@ main: clean $(objects)
clean: clean:
rm $(objects) || true rm $(objects) || true
doc.rst:$(headers) doc.rst:$(headers) README.rst
$(alldoc) doc.rst.tmp $(headers) $(alldoc) doc.rst.tmp $(headers)
printf "Documentation\n_____________\n\n" > doc.rst printf "Documentation\n_____________\n\n" > doc.rst
cat README.rst >> doc.rst
cat doc.rst.tmp >> doc.rst cat doc.rst.tmp >> doc.rst
rm doc.rst.tmp rm doc.rst.tmp

21
README.rst Normal file
View File

@ -0,0 +1,21 @@
A simple ASCII game
===================
Requirements
------------
This project requires
- A GNU89 compatible C compiler
- A GNU make compatible make program
- A terminal (emulator) that supports ANSI escape sequences
Licensing
---------
This project is licensed under the GNU Affero General Public License.
You are free to use, redistribute or modify the source under the terms
and conditions of the GNU AGPL.