aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2017-02-20 21:07:59 +0100
committerJohn MacFarlane <jgm@berkeley.edu>2017-02-20 21:07:59 +0100
commit3c8ccd2a9c67793f182179e7c5a221841ee2b6e2 (patch)
treef1f870951b15b7796f3f1a052f3218f772eec0c4 /CONTRIBUTING.md
parente390d754ef762d85db53a1e1ad978d16c30d68f7 (diff)
downloadpandoc-3c8ccd2a9c67793f182179e7c5a221841ee2b6e2.tar.gz
Modified documentation now that submodule fetching isn't needed.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md32
1 files changed, 17 insertions, 15 deletions
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: <http://github.com/jgm/pandoc>. 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 <https://github.com/jgm/pandoc-templates.git>.
+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: <http://github.com/jgm/pandoc>. 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