diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0d5929ef1da838f72f72c8e3766f7f14e7f7df3e 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.