From 39cba77254caa63cc1ff59eaca38441dffb1ae43 Mon Sep 17 00:00:00 2001 From: yoogx Date: Thu, 19 Feb 2015 14:11:39 +0100 Subject: [PATCH] * New README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index e69de29b..0d5929ef 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,16 @@ +* Installation + +See INSTALL file for more details on supported platforms and +installation process. + +* Examples + +Examples are located in the examples/ directory and are essentially +code generation examples. For more details, read the examples/README file + +* Documentation + +The documentation of Ocarina is located in the doc/ directory. The +documentation is automatically built and installed when running +'make install'. To build the documentation manually just run 'make html' +or 'make pdf' in the doc/ directory. -- GitLab