Cleanup on the Markdown sources; reflecting it on the translations.

[text-madewithcc.git] / HOWTO.md

diff --git a/HOWTO.md b/HOWTO.md
index a14ccee18b86883e589757df22c4bc37374b5cc9..fb2d93f2240ca448159a2ed82b6b0ffbda1cfdcc 100644 (file)
--- a/HOWTO.md
+++ b/HOWTO.md
@@ -45,6 +45,16 @@ Inside the `po` directory, we have one directory per target _locale_
 are stronger, such as Portuguese (would probably be `po/pt_BR`
 vs. `po/pt_PT`).
 
 are stronger, such as Portuguese (would probably be `po/pt_BR`
 vs. `po/pt_PT`).
 

+## Quick and easy: How to rebuild the sources
+
+You don't really need to follow this script; it's all scripted in a
+`Makefile`. To update the `.pot` (translation template) file, just
+run:
+
+    `make pot`
+
+That is enough to get you to the _Editing the Gettext files_ section.
+

 ## Markdown conversion
 
 Markdown is an easy to edit format, with very little markup, and
 ## Markdown conversion
 
 Markdown is an easy to edit format, with very little markup, and


@@ -57,6 +67,18 @@ We use Pandoc to convert the `odt` file into Markdown:
 We also include the source Markdown file, mostly as documentation, in
 the Git repository root directory.
 
 We also include the source Markdown file, mostly as documentation, in
 the Git repository root directory.
 

+### Markdown fixup
+
+The generated Markdown file is correct, but somewhat _dirty_. I came
+up with a quick-and-dirty(er) script to fix several issues,
+`fixup.rb`, and intend to update it as needed:
+
+    ruby fixup.rb source.md dest.md
+
+I still need to add to this fixup the needed markup so that the built
+material reflects the book's structure. It will happen :-) It will, of
+course, happen earlier if you send me some patches!
+

 ## Extracting strings for translation
 
 Gettext works by presenting each particular string to be edited. We
 ## Extracting strings for translation
 
 Gettext works by presenting each particular string to be edited. We