slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: FILES: updates

Browse Source
This commit is contained in:
Simon Michael 2022-12-05 09:50:07 -10:00
parent 6137f7003d
commit ecbfcd0e0d
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/FILES.md
View File

@ -254,7 +254,8 @@ src/hledger/tools/
## Sh/makefiles ## Sh/makefiles
Many developer tasks are automated with make and/or shake, also. Many developer tasks are automated with Make and/or Shake also.
Run `make` or `./Shake` (after `make Shake`) to see help.
<!-- $ gtree '(^|/)((bsd)?m|sh)ake' --> <!-- $ gtree '(^|/)((bsd)?m|sh)ake' -->
<pre> <pre>
@ -334,7 +335,7 @@ Core documentation which should stay closely synced with hledger's implementatio
are the user manuals, which get rendered as html, info, man and plain text. are the user manuals, which get rendered as html, info, man and plain text.
They are processed first with m4 for extra flexibility. They are processed first with m4 for extra flexibility.
- The hledger manual imports subcommand docs from hledger/Hledger/Cli/Commands/*.md. - The hledger manual imports the subcommand docs from hledger/Hledger/Cli/Commands/*.md.
- doc/ contains other developer docs. - doc/ contains other developer docs.
@ -463,6 +464,8 @@ src/hledger/
Additional docs (intro pages, faqs, tutorials, cookbook..) Additional docs (intro pages, faqs, tutorials, cookbook..)
are kept in the site repo's src/ directory. are kept in the site repo's src/ directory.
index.md is the home page.
SUMMARY.md defines the site structure.
Developer docs (UPPERCASE) and the latest dev manuals (dev/*.md) from Developer docs (UPPERCASE) and the latest dev manuals (dev/*.md) from
the main repo are also symbolically linked there, so that they too the main repo are also symbolically linked there, so that they too
@ -768,7 +771,7 @@ These help configure the website.
- [src/SUMMARY.md](https://github.com/simonmichael/hledger_site/blob/master/src/SUMMARY.md) - [src/SUMMARY.md](https://github.com/simonmichael/hledger_site/blob/master/src/SUMMARY.md)
defines the site's pages and which ones appear in the sidebar defines the site's pages and which ones appear in the sidebar
(except for old manual versions which are rendered separately). (except for old manual versions; those are rendered separately).
<!-- $ gtree 'Makefile|toml|css|js|theme|SUMMARY' --> <!-- $ gtree 'Makefile|toml|css|js|theme|SUMMARY' -->
<pre> <pre>