From 0064164d4ee9750a9a218d2cdf4fd9cb6ec07ca6 Mon Sep 17 00:00:00 2001 From: Adrian Perez de Castro Date: Mon, 8 Sep 2014 10:49:15 +0300 Subject: [PATCH] Convert HACKING.rst to Markdown --- HACKING.md | 24 ++++++++++++++++++++++++ HACKING.rst | 33 --------------------------------- 2 files changed, 24 insertions(+), 33 deletions(-) create mode 100644 HACKING.md delete mode 100644 HACKING.rst diff --git a/HACKING.md b/HACKING.md new file mode 100644 index 0000000..0748517 --- /dev/null +++ b/HACKING.md @@ -0,0 +1,24 @@ +# Fancy Index module Hacking HOW-TO + +## How to modify the template + +The template is in the `template.html` file. Note that comment markers are +used to control how the `template.awk` Awk script generates the C header +which gets ultimately included in the compiled object code. Comment markers +have the `` format. Here `identifier` must be +a valid C identifier. All the text following the marker until the next +marker will be flattened into a C string. + +If the identifier is `NONE` (capitalized) the text from that marker up to +the next marker will be discarded. + + +## Regenerating the C header + +You will need Awk. I hope any decent implementation will do, but the GNU one +is known to work flawlessly. Just do: + + $ awk -f template.awk template.html > template.h + +If your copy of `awk` is not the GNU implementation, you will need to +install it and use `gawk` instead in the command line above. diff --git a/HACKING.rst b/HACKING.rst deleted file mode 100644 index 8ffc76f..0000000 --- a/HACKING.rst +++ /dev/null @@ -1,33 +0,0 @@ -=================================== - Fancy Index module Hacking HOW-TO -=================================== - -.. contents:: - - -How to modify the template -========================== - -The template is in the ``template.html`` file. Note that comment markers are -used to control how the ``template.awk`` Awk script generates the C header -which gets ultimately included in the compiled object code. Comment markers -have the ```` format. Here ``identifier`` must be -a valid C identifier. All the text following the marker until the next -marker will be flattened into a C string. - -If the identifier is ``NONE`` (capitalized) the text from that marker up to -the next marker will be discarded. - - -Regenerating the C header -~~~~~~~~~~~~~~~~~~~~~~~~~ -You will need Awk. I hope any decent implementation will do, but the GNU one -is known to work flawlessly. Just do:: - - $ awk -f template.awk template.html > template.h - -If your copy of ``awk`` is not the GNU implementation, you will need to -install it and use ``gawk`` instead in the command line above. - -.. vim: spell spelllang=en expandtab -