diff --git a/Makefile b/Makefile index 1e416c5..ad3fa6d 100644 --- a/Makefile +++ b/Makefile @@ -23,9 +23,10 @@ main: clean $(objects) clean: rm $(objects) || true -doc.rst:$(headers) +doc.rst:$(headers) README.rst $(alldoc) doc.rst.tmp $(headers) printf "Documentation\n_____________\n\n" > doc.rst + cat README.rst >> doc.rst cat doc.rst.tmp >> doc.rst rm doc.rst.tmp diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..81e788d --- /dev/null +++ b/README.rst @@ -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. + + +