X-Git-Url: http://git.mutantstargoat.com/user/nuclear/?p=assman;a=blobdiff_plain;f=README.md;fp=README.md;h=802a6940ca1aec10f572e05775dd13d524b4f07d;hp=0000000000000000000000000000000000000000;hb=0a40e599114ea4b136601e5ba467eb0f8b48a839;hpb=53025831f330bce574a82d7be44ef2c4fcb46b77

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..802a694
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+assman
+======
+
+About
+-----
+Assman is a library for accessing assets (read only access to data files) in
+multiple ways through a simple file I/O interface designed as a drop-in
+replacement to C fopen/fread/etc I/O calls. In most cases you can just prefix
+all your I/O calls with `ass_` and change `FILE*` to `ass_file*`, and it will
+just work.
+
+The access modules provided are:
+ - `mod_path`: maps an arbitrary filesystem path to your chosen prefix. For
+   instance, after calling `ass_add_path("data", "/usr/share/mygame")` you can
+   access the data file `/usr/share/mygame/foo.png` by calling
+   `ass_fopen("data/foo.png", "rb")`.
+
+ - `mod_archive`: mounts the contents of an archive to your chosen prefix. For
+   example, after calling `ass_add_archive("data", "data.tar")` you can access
+   the contents of the tarball as if they where contents of a virtual `data`
+   directory.
+
+ - `mod_url`: maps a url prefix to your chosen prefix. For example, after
+   calling `ass_add_url("data", "http://mydomain/myapp/data")` you can access
+   `http://mydomain/myapp/data/foo.png` by calling
+   `ass_fopen("data/foo.png", "rb")`.
+
+NOTE: `mod_archive` is not implemented yet. Planned support for tar and zip
+archives.
+
+License
+-------
+Copyright (C) 2018 John Tsiombikas <nuclear@member.fsf.org>
+
+The assman library is free software. Feel free to use, modify, and/or
+redistribute it under the terms of the GNU Lesser General Public License
+version 3, or at your option any later version published by the Free Software
+Foundation. See COPYING and COPYING.LESSER for details.
+
+Build
+-----
+To build and install assman on UNIX, run the usual:
+
+    ./configure
+    make
+    make install
+
+The `mod_url` module depends on `libcurl` and uses POSIX threads. If you don't
+want that dependency, you can disable `mod_url` by passing `--disable-url` to
+`configure`.
+
+See `./configure --help` for a complete list of build-time options.
+
+To cross-compile for windows with mingw-w64, try the following incantation:
+
+    ./configure --prefix=/usr/i686-w64-mingw32
+    make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar sys=mingw
+    make install sys=mingw