forked from hplgit/fdm-book
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.do.txt
29 lines (22 loc) · 1.18 KB
/
README.do.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
======= fdm-book =======
Resources for the book *Finite Difference Computing with Partial Differential Equations* by Hans Petter Langtangen and Svein Linge.
!bquote
# #include "doc/.src/book/backcover.do.txt"
!equote
======= Directory structure =======
The book project follows the ideas of
"setup4book-dococe": "http://hplgit/github.io/setup4book-doconce/doc/web/index.html".
* `src`: source code for book examples
* `src/X`: source code from chapter `X`
* `doc`: documents for the book
* `doc/pub`: (preliminary) "published documents": "http://hplgit/github.io/fdm-book/doc/web/index.html"
* `doc/pub/book`: complete (preliminary) published book
* `doc/pub/X`: (preliminary) published chapter `X`
* `doc/.src`: DocOnce source code and computer code
* `doc/.src/book`: DocOnce source code for assembling the complete book
* `doc/.src/chapters/X`: DocOnce source code for chapter `X`
Source files are compiled in `doc/.src/chapters/X` (a specific chapter)
or `/doc/.src/book` (the entire book) and copied to some subdirectory
under `doc/pub` for publication in the gh-pages branch.
Development takes place in the master branch, and the gh-pages branch
is always merged and in sync with master.