search

CDSoft / pp

PP - Generic preprocessor (with pandoc in mind) - macros, literate programming, diagrams, scripts...
http://cdelord.fr/pp
GNU General Public License v3.0
253 stars 21 forks source link

Fix Markdown Formatting in README #14

Closed tajmone closed 7 years ago

tajmone commented 7 years ago

Minor formatting-breaking typos in !import and !comment macros description.

tajmone commented 7 years ago

PS: I've pushed changes in separate commits (mainly organized by type of fixes) because you might wish to merge some or discard others.

I've noticed that pp is mentioned in differing ways in the README:

maybe it would be better to have a consistent way of referring to it (PP looks nicer IMO).

I also propose to document the command line options/flags using the same formatting as for the macros: options on first line in bold and backticked (now they are just bold). It's more readable and consistent. I've made a separate commit (785e063) for it, and if you like it you merge it in.

CDSoft commented 7 years ago

README.md is generated by pp and pandoc. The actual source is pp.md. I have backported these corrections to pp.md. Thanks.