Initial dependency configuration

1 files changed, 44 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..1767614
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+This archive contains pre-configured CLI source code with all its 
+dependencies. It allows you to built CLI in non-interactive mode
+(that is, without answering any questions).
+
+GNU make 3.81 or later is required to build CLI. Any fairly recent 
+GNU/Linux distribution should have it already installed (use 
+make --version to check).
+
+The build system supports the following standard variables:
+
+CXX        (defaults to g++ if not set)
+CPPFLAGS
+CXXFLAGS
+LDFALGS
+LIBS
+
+For example:
+
+$ make CXX=g++-4.2 CXXFLAGS=-O3
+
+After the build, the CLI compiler can be found in the cli/cli/ directory.
+
+If you would like to see the full compiler/linker/etc., command lines,
+you can add verbose=1 to the command line, for example:
+
+$ make verbose=1
+
+To build and run automated tests for the CLI compiler as well as all the
+dependencies, run:
+
+$ make test
+
+The clean the object files, libraries, executable, etc., run:
+
+$ make clean
+
+You can also run make from various sub-directories in this package. For
+example, to build and run automated tests only for the CLI compiler, we
+can do the following:
+
+$ cd cli/tests
+$ make test
+
+Send bug reports or any other feedback to boris@codesynthesis.com.