https://github.com/norfairking/microblx_documentation

Documentation for the microblx project
https://github.com/norfairking/microblx_documentation

Last synced: about 2 months ago
JSON representation

Documentation for the microblx project

• Host: GitHub
• URL: https://github.com/norfairking/microblx_documentation
• Owner: NorfairKing
• Created: 2014-07-04T06:29:41.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-29T16:30:05.000Z (over 10 years ago)
• Last Synced: 2024-05-01T12:37:42.397Z (8 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 932 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

README

        
* Microblx Documentation

This repository contains documentation for the microblx metamodel.

The documentation can be viewed directly on github via the org directory.

You can start at [[https://github.com/NorfairKing/microblx_documentation/blob/master/org/index.org][the index]]. Note that links between the files will not work on github, only when you generate the html code.

** Generating the html

The documentation can also be used to generate html code using the makefile.

Just run the following command to generate the html code. It will then be available in the public_html directory.

#+BEGIN_EXAMPLE

make

#+END_EXAMPLE

You will need emacs org-mode to do this.

If ever you add any svg pictures in the illustrations directory, you must run the following command to use it in the documentation.

#+BEGIN_EXAMPLE

make images

#+END_EXAMPLE

You will need inkscape to do this.