summaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 41 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..7962ca0
--- /dev/null
+++ b/README
@@ -0,0 +1,41 @@
+ntcon: free-standing console interface definitions
+--------------------------------------------------
+
+
+how to build (quick)
+--------------------
+
+git clone git://midipix.org/ntcon &&
+mkdir ntcon_build &&
+cd ntcon_build &&
+../ntcon/configure --host=$HOST &&
+make &&
+make DESTDIR=$DESTDIR install
+
+* native builds are supported (leave out --host).
+* both in-tree and out-of-tree builds are supported.
+
+
+supported targets
+-----------------
++ x86_64-nt64-midipix
++ x86_64-w64-mingw32
++ i686-nt32-midipix
++ i686-w64-mingw32
+
+
+supported compilers
+-------------------
++ gcc
++ clang
++ Visual Studio
+
+
+IDE project files (forthcoming)
+-------------------------------
++ CodeLite
++ Code::Blocks
++ Visual Studio
+
+* above project files will not be part of the project
+ repository, but rather distributed separately.