Modified documentation now that submodule fetching isn't needed.

This commit is contained in:
John MacFarlane 2017-02-20 21:07:59 +01:00
parent e390d754ef
commit 3c8ccd2a9c
3 changed files with 22 additions and 28 deletions

View file

@ -215,28 +215,30 @@ With stack:
pandoc +RTS -p -RTS [file]... pandoc +RTS -p -RTS [file]...
less pandoc.prof less pandoc.prof
Templates
---------
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.
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 subtree push --prefix=data/templates templates master
where `templates` is a remote pointing to the templates
repository.
The code The code
-------- --------
Pandoc has a publicly accessible git repository on Pandoc has a publicly accessible git repository on
github: <http://github.com/jgm/pandoc>. To get a local copy of the source: github: <http://github.com/jgm/pandoc>. To get a local copy of the source:
git clone git://github.com/jgm/pandoc.git git clone https://github.com/jgm/pandoc.git
Note: after cloning the repository (and in the future after pulling from it),
you should do
git submodule update --init
to pull in changes to the templates (`data/templates/`). You can automate this
by creating a file `.git/hooks/post-merge` with the contents:
#!/bin/sh
git submodule update --init
and making it executable:
chmod +x .git/hooks/post-merge
The source for the main pandoc program is `pandoc.hs`. The source for 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 the pandoc library is in `src/`, the source for the tests is in

View file

@ -112,7 +112,6 @@ Or you can fetch the development code by cloning the repository:
git clone https://github.com/jgm/pandoc git clone https://github.com/jgm/pandoc
cd pandoc cd pandoc
git submodule update --init # to fetch the templates
Note: there may be times when the development code is broken Note: there may be times when the development code is broken
or depends on other libraries which must be installed or depends on other libraries which must be installed
@ -159,13 +158,6 @@ The easiest way to build pandoc from source is to use [stack]:
cabal install cabal install
Note: If you obtained the source from the git repository (rather
than a release tarball), you'll need to do
git submodule update --init
to fetch the contents of `data/templates` before `cabal install`.
4. Make sure the `$CABALDIR/bin` directory is in your path. You should 4. Make sure the `$CABALDIR/bin` directory is in your path. You should
now be able to run `pandoc`: now be able to run `pandoc`:
@ -329,14 +321,13 @@ maximal build method would be
git clone https://github.com/jgm/cmark-hs git clone https://github.com/jgm/cmark-hs
git clone https://github.com/jgm/zip-archive git clone https://github.com/jgm/zip-archive
cd pandoc cd pandoc
git submodule update --init
stack install --test --install-ghc --stack-yaml stack.full.yaml stack install --test --install-ghc --stack-yaml stack.full.yaml
To pull in the latest changes, after you've done this and there have been To pull in the latest changes, after you've done this and there have been
changes in the repositories: Visit each repository in pandoc-build changes in the repositories: Visit each repository in pandoc-build
(pandoc-types, texmath, pandoc-citeproc, pandoc, zip-archive, cmark-hs) and do (pandoc-types, texmath, pandoc-citeproc, pandoc, zip-archive, cmark-hs) and do
`git pull`. In the pandoc repo, also do `git submodule update` and `stack `git pull`. In the pandoc repo, also do `stack install --test
install --test --stack-yaml stack.full.yaml`. --stack-yaml stack.full.yaml`.
[Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/ [Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/

View file

@ -7,7 +7,8 @@ _ make man/pandoc.1 and commit if needed
_ Tag release in git _ Tag release in git
_ Tag templates _ Push templates:
git subtree push --prefix=data/templates templates master
_ Generate Windows package (make winpkg) _ Generate Windows package (make winpkg)