git.iko.soy/typeable/pandoc
on master help sign in
Modified documentation now that submodule fetching isn't needed.
commit3c8ccd2a9c67793f182179e7c5a221841ee2b6e2 authorJohn MacFarlane <jgm@berkeley.edu> dateMon 20 Feb 2017, 21:07 (10 years ago) parente390d75
3 files changed+21−27
compare with master
unifiedsplit
CONTRIBUTING.md+17−15 INSTALL.md+2−11 RELEASE-CHECKLIST+2−1
CONTRIBUTING.md+17−15
@@ -215,28 +215,30 @@ With stack:
215215 pandoc +RTS -p -RTS [file]...
216216 less pandoc.prof
217217
218−The code
219−--------
220−
221−Pandoc has a publicly accessible git repository on
222−github: <http://github.com/jgm/pandoc>. To get a local copy of the source:
218+Templates
219+---------
223220
224− git clone git://github.com/jgm/pandoc.git
221+The default templates live in `data/templates`, which is a git
222+subtree linked to <https://github.com/jgm/pandoc-templates.git>.
223+The purpose of maintaining a separate repository is to allow
224+people to maintain variant templates as a fork.
225225
226−Note: after cloning the repository (and in the future after pulling from it),
227−you should do
226+You can modify the templates and submit patches without worrying
227+much about this: when these patches are merged, we will
228+push them to the main templates repository by doing
228229
229− git submodule update --init
230+ git subtree push --prefix=data/templates templates master
230231
231−to pull in changes to the templates (`data/templates/`). You can automate this
232−by creating a file `.git/hooks/post-merge` with the contents:
232+where `templates` is a remote pointing to the templates
233+repository.
233234
234− #!/bin/sh
235− git submodule update --init
235+The code
236+--------
236237
237−and making it executable:
238+Pandoc has a publicly accessible git repository on
239+github: <http://github.com/jgm/pandoc>. To get a local copy of the source:
238240
239− chmod +x .git/hooks/post-merge
241+ git clone https://github.com/jgm/pandoc.git
240242
241243The source for the main pandoc program is `pandoc.hs`. The source for
242244the pandoc library is in `src/`, the source for the tests is in
INSTALL.md+2−11
@@ -112,7 +112,6 @@ Or you can fetch the development code by cloning the repository:
112112
113113 git clone https://github.com/jgm/pandoc
114114 cd pandoc
115− git submodule update --init # to fetch the templates
116115
117116Note: there may be times when the development code is broken
118117or depends on other libraries which must be installed
@@ -159,13 +158,6 @@ The easiest way to build pandoc from source is to use [stack]:
159158
160159 cabal install
161160
162− Note: If you obtained the source from the git repository (rather
163− than a release tarball), you'll need to do
164−
165− git submodule update --init
166−
167− to fetch the contents of `data/templates` before `cabal install`.
168−
1691614. Make sure the `$CABALDIR/bin` directory is in your path. You should
170162 now be able to run `pandoc`:
171163
@@ -329,14 +321,13 @@ maximal build method would be
329321 git clone https://github.com/jgm/cmark-hs
330322 git clone https://github.com/jgm/zip-archive
331323 cd pandoc
332− git submodule update --init
333324 stack install --test --install-ghc --stack-yaml stack.full.yaml
334325
335326To pull in the latest changes, after you've done this and there have been
336327changes in the repositories: Visit each repository in pandoc-build
337328(pandoc-types, texmath, pandoc-citeproc, pandoc, zip-archive, cmark-hs) and do
338−`git pull`. In the pandoc repo, also do `git submodule update` and `stack
339−install --test --stack-yaml stack.full.yaml`.
329+`git pull`. In the pandoc repo, also do `stack install --test
330+--stack-yaml stack.full.yaml`.
340331
341332
342333[Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/
RELEASE-CHECKLIST+2−1
@@ -7,7 +7,8 @@ _ make man/pandoc.1 and commit if needed
77
88_ Tag release in git
99
10−_ Tag templates
10+_ Push templates:
11+ git subtree push --prefix=data/templates templates master
1112
1213_ Generate Windows package (make winpkg)
1314