Skip to content

Commit 63ddafe

Browse files
committed
add info about paper generation + update pdf
1 parent 13df42e commit 63ddafe

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,22 @@ Repository for the documentation of the Dat Project ecosystem. View the docs at
1010

1111
[See docs folder](docs/readme.md) for information on editing and adding docs. Once you finish editing the docs, send a PR to the `deploy` branch to get the edits automatically deployed.
1212

13+
### Creating + Generating Paper from Markdown
14+
15+
[See this gist](https://gist.github.com/maxogden/97190db73ac19fc6c1d9beee1a6e4fc8) for more information on how the paper is created with a basic example.
16+
17+
To generate the paper again, make sure you have `pandoc` and `pandoc-citeproc`:
18+
19+
```
20+
brew install pandoc pandoc-citeproc
21+
```
22+
23+
Then run the npm script:
24+
25+
```
26+
npm run paper
27+
```
28+
1329
## Development
1430

1531
This documentation uses [minidocs](https://github.com/freeman-lab/minidocs) for layout, [ecosystem-docs](https://github.com/hughsk/ecosystem-docs) to get documentation from other modules, and ideas from [pull-stream-docs](https://github.com/pull-stream/pull-stream-docs) for auto travis deployment.

papers/dat-paper.pdf

-17 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)