From fcaf284100aff06238be3ac74c360f0ca15be01a Mon Sep 17 00:00:00 2001 From: Martin Fouilleul Date: Wed, 16 Nov 2022 07:37:56 -0800 Subject: [PATCH] added readme and fixed download instructions --- Readme.md | 18 ++++++++++++++++++ example/doc.groucho.txt | 8 ++++---- example/doc.html | 9 ++++----- 3 files changed, 26 insertions(+), 9 deletions(-) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..3d3656e --- /dev/null +++ b/Readme.md @@ -0,0 +1,18 @@ +## 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` \ No newline at end of file diff --git a/example/doc.groucho.txt b/example/doc.groucho.txt index 21fbdd9..f95b993 100644 --- a/example/doc.groucho.txt +++ b/example/doc.groucho.txt @@ -13,9 +13,9 @@ ------------------------------------------------\ == Intro == -Groucho is a little tool to generate an HTML file from a text containing simplified and non-intrusive markup codes. +Groucho is a janky little tool to generate an HTML file from a text containing simplified and non-intrusive markup codes. -It was written in order to ease writing blog posts for my website. Its goal is to allow to write content along with formatting instructions, aiming at the least friction, thus avoiding the need to do a second pass manually adding html tags or using a more complex editing tool, a process that is repetitive and tedious, and makes the source text less readable. +It was written in order to ease writing blog posts for my website, aiming at the least friction. As the content I'm writting on these posts is mainly technical, Groucho is built around three main goals\s: @@ -38,9 +38,9 @@ Some examples : 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 can download the sources [url=https://www.forkingpaths.garden/download.php?id=15]HERE[/url]. 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. +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 downloading and extracting the archive, you should be able to compile in the source directory with\s: +After cloning the repo, you should be able to compile in the source directory with\s: [code=none]cc -o groucho *.cpp[/code] \ diff --git a/example/doc.html b/example/doc.html index a5ef132..fc663dd 100644 --- a/example/doc.html +++ b/example/doc.html @@ -15,10 +15,10 @@

Intro

-Groucho is a little tool to generate an HTML file from a text containing simplified and non-intrusive markup codes. +Groucho is a janky little tool to generate an HTML file from a text containing simplified and non-intrusive markup codes.

-It was written in order to ease writing blog posts for my website. Its goal is to allow to write content along with formatting instructions, aiming at the least friction, thus avoiding the need to do a second pass manually adding html tags or using a more complex editing tool, a process that is repetitive and tedious, and makes the source text less readable. +It was written in order to ease writing blog posts for my website, aiming at the least friction.

As the content I'm writting on these posts is mainly technical, Groucho is built around three main goals : @@ -49,11 +49,10 @@ Some examples : 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 can download the sources HERE -. 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. +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 downloading and extracting the archive, you should be able to compile in the source directory with : +After cloning the repo, you should be able to compile in the source directory with :

cc -o groucho *.cpp