From 63ddafe9c003d7190cfa1b8626fb719ab6149c8d Mon Sep 17 00:00:00 2001 From: Joe Hand Date: Mon, 8 May 2017 09:40:18 -0700 Subject: add info about paper generation + update pdf --- README.md | 16 ++++++++++++++++ papers/dat-paper.pdf | Bin 270690 -> 270673 bytes 2 files changed, 16 insertions(+) diff --git a/README.md b/README.md index 8673a9b..4cc8f70 100644 --- a/README.md +++ b/README.md @@ -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 index 93ea51e..82d6e13 100644 Binary files a/papers/dat-paper.pdf and b/papers/dat-paper.pdf differ -- cgit v1.2.3