Skip to content

Commit a7ec24d

Browse files
committed
Update README
1 parent 61f433b commit a7ec24d

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ Generate your documents with:
5050
pdfbaker <path_to_config_file>
5151
```
5252

53-
This will create a `build/` directory and a `dist/` directory (both ignored by git).<br>
53+
This will create a `build/` directory and a `dist/` directory where your configuration file lives.<br>
5454
It will produce your PDF files in the `dist/` directory (and leave some artifacts in the
55-
`build/` directory, mainly for debugging).
55+
`build/` directory to aid debugging).
5656

5757
## Configuration
5858

59-
**FIXME: This is hard to find useful without seeing an example.**
59+
**FIXME: This is hard to find useful without seeing an example or the required settings to e.g. enable compression.**
6060

6161
A **document** is made up of **pages**.<br> Pages take their layout from **templates**,
6262
and their specific content from your **configuration**. They may also include
@@ -100,6 +100,8 @@ another might creates half a dozen variations of itself. All that logic is in yo
100100

101101
## Development
102102

103+
The source code of pdfbaker lives [on github](https://github.com/pythonnz/pdfbaker).
104+
103105
Your changes will be rejected by github if the linters throw warnings. You should
104106
install [pre-commmit](https://pre-commit.com) and run
105107

0 commit comments

Comments
 (0)