From 2682bc5d1d864341aaeb42a449db73c3ecd16d70 Mon Sep 17 00:00:00 2001
From: "Juan J. Martinez" <jjm@usebox.net>
Date: Wed, 30 Dec 2020 19:07:31 +0000
Subject: Initial import

---
 README.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 109 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..366fe4f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,109 @@
+# ubox MSX lib
+
+This is a set of libraries and tools to make MSX games using the C programming
+language.
+
+There are three components:
+
+  - **ubox**: thin wrapper around MSX 1 BIOS, focusing on Screen 2 and 32K
+    cartridge ROMs.
+  - **spman**: a simple sprite and pattern manager with flickering support.
+  - **mplayer**: a wrapper around Arkos 2 AKM player, supporting music and
+    priority based one channel sound effects.
+
+The aim is making MSX games in C, without writing Z80 assembler or having a
+deep knowledge of the system.
+
+## Requirements
+
+ - SDCC (3.9.0 recommended)
+ - GNU Make (others may work)
+ - a POSIX compatible environment
+
+If you want to build the example you will also need:
+
+ - python 3
+ - pillow
+ - GCC (only the C compiler)
+
+If you want to build the docs you will also need:
+
+ - pandoc
+ - python 3
+ - pygments
+ - pandocfilters
+
+## Building
+
+To build the libraries run:
+
+    make
+
+After a successful build, the libraries should be in `./lib`.
+
+The include files are ready to use in `./include`.
+
+Add those directories in `SDCC`'s search path and you are ready to go.
+
+### Building the example
+
+An example game is included with the libraries and it can be built with:
+
+    make game
+
+After a successful build, the game ROM should be in `./bin`.
+
+### Building the docs
+
+The documentation is available at
+[usebox.net](https://www.usebox.net/jjm/ubox-msx-lib/), so this is optional.
+
+To build the docs run:
+
+    make docs
+
+The reference in `HTML` format will be generated in `./docs`.
+
+## Contributing
+
+All contributions are welcome.
+
+If you think you have found a bug, please submit a bug report providing some
+information:
+
+ - What was expected to happen
+ - What actually happens
+ - How to reproduce the issue
+
+Some advice if you want to make a successful contribution:
+
+ - Be cordial
+ - Get early feedback, specially when working on a large contribution
+ - Contributions always require a pull request and a review
+
+## Authors
+
+This was mostly written by Juan J. Martinez during the development of
+[Night Knight](https://www.usebox.net/jjm/night-knight/) and
+[Uchūsen Gamma](https://www.usebox.net/jjm/uchusen-gamma/).
+
+ - Juan J. Martinez <jjm@usebox.net>
+ - Your name here?
+
+## Copying
+
+This software is distributed under MIT license, unless stated otherwise.
+
+See COPYING file.
+
+**TL;DR**: the only condition is that you are required to preserve the copyright
+and license notices. Licensed works, modifications, and larger works may be
+distributed under different terms and without source code; this includes any game
+made with the help of this software.
+
+Credit is appreciated, but is not a legal requirement. For example: you can add
+to the game's documentation a note like "This game uses ubox MSX lib".
+
+There are some third party tools included here for convenience and are covered
+by their own license or are public domain.
+
-- 
cgit v1.2.3