Browse Source

Better README for ctan, as requested following the first upload

master
Matthieu Moy 5 years ago
parent
commit
7509f588ce
  1. 13
      Makefile
  2. 33
      README.md

13
Makefile

@ -81,7 +81,18 @@ dist/git-latexdiff.zip: force
-$(RM) -fr dist/git-latexdiff/
mkdir -p dist/git-latexdiff/bin/ dist/git-latexdiff/man
$(MAKE) gitexecdir=$(PWD)/dist/git-latexdiff/bin gitmanpath=$(PWD)/dist/git-latexdiff/man/ install
./git-latexdiff --help > dist/git-latexdiff/README.txt
(sed -ne '1,/Installation/p' README.md | head -n -1 ;\
echo 'The output of git-latexdiff -h is given below:' ;\
echo ;\
echo '```' ;\
./git-latexdiff --help ;\
echo '```' ;\
echo ;\
echo "Examples" ;\
echo "--------" ;\
echo ;\
./git-latexdiff --help-examples | grep -v "^Examples:" ;\
)> dist/git-latexdiff/README.md
cd dist/ && zip -r git-latexdiff.zip git-latexdiff
@echo "dist/git-latexdiff.zip generated."

33
README.md

@ -15,6 +15,26 @@ running `latexdiff` (this usually works better than using `latexdiff
To get the manpage (needed to get `git-latexdiff --help` to work), you
need the `a2x` tool from the asciidoc package.
Copying
-------
git-latexdiff's main author is [Matthieu
Moy](https://matthieu-moy.fr/). The script is freely distributable and
modifyable under the terms of the simplified BSD licence.
Documentation
-------------
The documentation is available through these commands:
git-latexdiff -h
git-latexdiff --help-examples
If you installed the manpage properly, you can get the same
documentation with:
man git-latexdiff
Installation
------------
@ -52,16 +72,3 @@ To get the documentation, you need to generate it:
and then copy `git-latexdiff.1` in your man-path (run `git --man-path`
to get the location).
Documentation
-------------
The documentation is available through these commands:
git-latexdiff -h
git-latexdiff --help-examples
If you installed the manpage properly, you can get the same
documentation with:
man git-latexdiff
Loading…
Cancel
Save