diff options
author | Joe Hand <joe@hand.email> | 2017-05-08 09:40:18 -0700 |
---|---|---|
committer | Joe Hand <joe@hand.email> | 2017-05-08 09:40:18 -0700 |
commit | 63ddafe9c003d7190cfa1b8626fb719ab6149c8d (patch) | |
tree | 5d5d4e8eb01f53a1642efefffb1925aecaf7f1e3 | |
parent | 13df42efd27b4c7d03e4e064b602931b7d3ca924 (diff) | |
download | dat-docs-63ddafe9c003d7190cfa1b8626fb719ab6149c8d.tar.gz dat-docs-63ddafe9c003d7190cfa1b8626fb719ab6149c8d.zip |
add info about paper generation + update pdf
-rw-r--r-- | README.md | 16 | ||||
-rw-r--r-- | papers/dat-paper.pdf | bin | 270690 -> 270673 bytes |
2 files changed, 16 insertions, 0 deletions
@@ -10,6 +10,22 @@ Repository for the documentation of the Dat Project ecosystem. View the docs at [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. +### Creating + Generating Paper from Markdown + +[See this gist](https://gist.github.com/maxogden/97190db73ac19fc6c1d9beee1a6e4fc8) for more information on how the paper is created with a basic example. + +To generate the paper again, make sure you have `pandoc` and `pandoc-citeproc`: + +``` +brew install pandoc pandoc-citeproc +``` + +Then run the npm script: + +``` +npm run paper +``` + ## Development 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. diff --git a/papers/dat-paper.pdf b/papers/dat-paper.pdf Binary files differindex 93ea51e..82d6e13 100644 --- a/papers/dat-paper.pdf +++ b/papers/dat-paper.pdf |