Update build documentation

[zilutils.git] / README.md

diff --git a/README.md b/README.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..3aabb24fb081bb347a1204114be3ac57a9ef80b1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -0,0 +1,44 @@
+The zilutils comprise a compiler and assembler that target the 
+Z-Machine. The Z-Machine is a virtual machine developed by the people 
+at Infocom for their games: <https://en.wikipedia.org/wiki/Z-machine>.
+
+The zilutils are licensed under version 3 of the GNU Affero General 
+Public License or, at your option, any later version. See COPYING for 
+details.
+
+It is currently a work-in-progress. All contributions are welcome.
+
+To build this you will need a C compiler (GCC is assumed although 
+others may work), GNU Autoconf, and GNU Make. Your GNU/Linux distro 
+probably has these already packaged for easy installation.
+
+Once these are installed first run autoreconf --install then you 
+should be able to do the usual dance of:
+
+./configure
+make
+make install
+
+You can invoke the configure script with --help to see additional 
+information.
+
+Licensing
+=========
+
+This file is part of zilutils.
+
+You can redistribute and/or modify this file under the terms of the 
+GNU Affero General Public License as published by the Free Software 
+Foundation, either version 3 of the license, or (at your option) any 
+later version.
+
+This file is distributed in the hope that it will be useful, but 
+WITHOUT ANY WARRANTY; without even the implied warranty of 
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
+Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public 
+License along with this file. If not, see 
+<http://www.gnu.org/licenses/>
+
+\$-- SPDX-License-Identifier: AGPL-3.0-or-later