README.md - tgtimes - The Gopher Times | |
git clone git://bitreich.org/tgtimes git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws… | |
Log | |
Files | |
Refs | |
Tags | |
README | |
--- | |
README.md (1711B) | |
--- | |
1 The Gopher Times | |
2 ================ | |
3 Welcome to editor office of The Gopher Times. | |
4 | |
5 The newspaper uses Plan 9 version of troff(1). Install plan9port and | |
6 run `make` on Linux/BSD/... or run `mk` on Plan 9. | |
7 | |
8 ``` | |
9 opus - "v=1", or "v=2", ..., to maintain by hand | |
10 opus$v/article-*.mw - troff source of the articles included | |
11 opus$v/tgtimes$v.mw - the troff source that includes the articles | |
12 opus$v/tgtimes$v.pdf - working draft, pdf version (troff) | |
13 opus$v/tgtimes$v.txt - working draft, plain text version (nroff) | |
14 archive/YYYY-MM-DD/ - generated from opus$v with `mk publish` | |
15 archive/YYYY-MM-DD-errata1/ - archive/YYYY-MM-DD, copied by hand | |
16 ``` | |
17 | |
18 Dependencies | |
19 ------------ | |
20 * POSIX make | |
21 * u2ps for Postscript to PDF conversion: | |
22 https://github.com/arsv/u2ps | |
23 * Ghostscript for ps2pdf | |
24 * boxes for fancy ASCII textboxes: | |
25 https://github.com/ascii-boxes/boxes | |
26 https://boxes.thomasjensen.com/ | |
27 | |
28 Generating a document | |
29 --------------------- | |
30 `make` on Linux/BSD/... or `mk` will generate `opus$v/tgtimes$v.{pdf,txt… | |
31 For generating another document, run `make thedocument.pdf` for instance. | |
32 The main `tgtimes$v.mw` file has usually the header of the document, then | |
33 a list of `.so opus$v/article-[...].mw` to source each article. | |
34 | |
35 Publishing an edition | |
36 --------------------- | |
37 1. Run `make clean publish` or `mk publish` to create `YYYY-MM-DD/` from… | |
38 2. Update the version with `echo v=123 >opus` | |
39 3. Commit the changes and push. | |
40 | |
41 Publishing an errata | |
42 -------------------- | |
43 1. Run `cp -r YYYY-MM-DD YYYY-MM-DD-errata1` to prepare the new release. | |
44 2. Edit the files in the `opus$v` directory that match the publication. | |
45 3. Run `make YYYY-MM-DD-errata1/tgtimes$v.{pdf,txt}` to rebuild it. | |
46 4. Commit the changes and push. |