Initial import

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5a92c72
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# ubox lib for DOS
+
+This is a simple library to make DOS games with DJGPP.
+
+Required:
+
+- GNU Make
+- DJGPP C (using GCC 12.1.0; other may work)
+- [libmikmod](https://mikmod.sourceforge.net/)
+
+For DJGPP I recommend cross-compilation using [build-djgpp](https://github.com/andrewwutw/build-djgpp/).
+
+How to use it:
+
+- set `LIBMIKMOD_BASE` env variable to your libmikmod sources
+- build the library with `make`
+- link your code with `ubox` and `mikmod` libraries (build `libmikmod` for DOS yourself)
+
+## Author
+
+This was made by [Juan J. Martinez](https://www.usebox.net/jjm/about/me/).
+
+The code is licensed MIT, see [docs/uboxl.txt](docs/uboxl.txt) file.
+
+When distributing your works made with this library, you need to include the
+files in the `docs/` directory.
+
+Visit [the project website](https://git.usebox.net/uboxlib-dos/about/) for updates.
+