From 3c8ccd2a9c67793f182179e7c5a221841ee2b6e2 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Mon, 20 Feb 2017 21:07:59 +0100 Subject: Modified documentation now that submodule fetching isn't needed. --- CONTRIBUTING.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9feb0b6a0..c011faeb9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -215,28 +215,30 @@ With stack: pandoc +RTS -p -RTS [file]... less pandoc.prof -The code --------- - -Pandoc has a publicly accessible git repository on -github: . To get a local copy of the source: +Templates +--------- - git clone git://github.com/jgm/pandoc.git +The default templates live in `data/templates`, which is a git +subtree linked to . +The purpose of maintaining a separate repository is to allow +people to maintain variant templates as a fork. -Note: after cloning the repository (and in the future after pulling from it), -you should do +You can modify the templates and submit patches without worrying +much about this: when these patches are merged, we will +push them to the main templates repository by doing - git submodule update --init + git subtree push --prefix=data/templates templates master -to pull in changes to the templates (`data/templates/`). You can automate this -by creating a file `.git/hooks/post-merge` with the contents: +where `templates` is a remote pointing to the templates +repository. - #!/bin/sh - git submodule update --init +The code +-------- -and making it executable: +Pandoc has a publicly accessible git repository on +github: . To get a local copy of the source: - chmod +x .git/hooks/post-merge + git clone https://github.com/jgm/pandoc.git The source for the main pandoc program is `pandoc.hs`. The source for the pandoc library is in `src/`, the source for the tests is in -- cgit v1.2.3