X-Git-Url: https://git.jsancho.org/?p=guile-assimp.git;a=blobdiff_plain;f=README;h=6defdde360a8af70286a331392aa9a3d0b7e99d5;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hb=HEAD;hpb=ceafd0037f102ffbb2b902b6ccb0b9701f3ae1ba

diff --git a/README b/README
index e69de29..6defdde 100644
--- a/README
+++ b/README
@@ -0,0 +1,27 @@
+Guile-assimp
+============
+
+Guile-assimp is a set of GNU Guile bindings to the Open Asset Import
+Library (assimp). Guile-assimp works with GNU Guile 2.0.11 or later.
+See [the Guile-assimp page](https://gitorious.org/guile-assimp) for more
+details.
+
+[Open Asset Import Library](https://github.com/assimp/assimp) is a Open
+Source library designed to load various 3d file formats and convert them
+into a shared, in-memory format. It supports more than 40 file formats for
+import and a growing selection of file formats for export.
+
+Installation
+------------
+
+The following programs/libraries are required to accomplish the build process:
+
+- make
+- guile 2.0 (or later)
+- assimp (with headers)
+
+If those are provided, just type ./configure && make && make install.
+
+In the "examples" directory you can find a sample program to test the library.
+You will need [figl module](https://gitorious.org/guile-figl) installed to
+run it.