You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
18 lines
1.2 KiB
18 lines
1.2 KiB
## Groucho - A marXup language
|
|
|
|
Groucho is a janky little tool to generate an HTML file from a text containing simplified and non-intrusive markup codes. You can see the documentation, generated from a groucho file, in `examples/doc.html`.
|
|
|
|
### To compile groucho
|
|
|
|
The source code of Groucho is available under a Public domain or MIT license (choose whichever you prefer). The fonts provided for the example document are covered by their own licenses (X11 license for CMU and the GUST font license for latin-modern-maths), which you can find in the font directory.
|
|
|
|
You clone the repo from `https://git.forkingpaths.dev/martinfouilleul/groucho.git`. Please keep in mind though that this was written as a quick side-project for my personal use, and hence is far for production quality. It is made available online only in the interest of the reader's curiosity. It may or may not be updated in the future.
|
|
|
|
After cloning the repo, you should be able to compile in the source directory with :
|
|
|
|
In the terminal, `cd` the the groucho directory, and type `cc -o groucho *.cpp`
|
|
|
|
### To run groucho
|
|
|
|
Simply type `groucho inputFile outputFile`.
|
|
E.g. to re-generate the html documentation, type `groucho example/doc.groucho.txt example/doc.html` |