diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2015-09-28 13:40:23 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2015-09-28 13:40:23 -0700 |
| commit | 3b70941a69814812b3948a4ee9f5f0350ea03848 (patch) | |
| tree | e9e31ee96d436211c12a1ec6650f2c384dcbca62 | |
| parent | c8faa81cd31ca8828c83f954540a7cb0958bddb2 (diff) | |
| download | oso2pdf-3b70941a69814812b3948a4ee9f5f0350ea03848.tar.gz | |
improve readme
| -rw-r--r-- | README.md | 31 | ||||
| -rw-r--r-- | oso2pdf.cabal | 2 |
2 files changed, 30 insertions, 3 deletions
@@ -48,15 +48,42 @@ Runtime dependencies: - a working LaTeX installation, including XeLaTeX - some XeLaTeX-compatible font, such as Liberation Serif -To build and install, first -[install stack](https://github.com/commercialhaskell/stack), and then +`oso2pdf` is available from Hackage, so if you have a working Haskell +installation on your machine you should just be able to run `cabal +install oso2pdf`. But instead, I recommend installing [stack][] and +then $ git clone git@github.com:spwhitton/oso2pdf.git $ cd oso2pdf $ stack install + +which will put the `oso2pdf` and `pandoc-oso2tex` binaries in +~/.local/bin, which should be in your PATH environment variable if +you've set stack up correctly. + +[stack]: https://github.com/commercialhaskell/stack + ## Bugs Please report bugs by e-mail to `<spwhitton@spwhitton.name>` or `<spwhitton@email.arizona.edu>`. I'd also appreciate hearing from you if this program has been useful to you. + +## License + +Copyright (C) 2015 Sean Whitton + +oso2pdf is free software: you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version. + +oso2pdf is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. + +You should have received a copy of the GNU General Public License +along with oso2pdf. If not, see +[<http://www.gnu.org/licenses/>](http://www.gnu.org/licenses/). diff --git a/oso2pdf.cabal b/oso2pdf.cabal index f1f4126..7c15250 100644 --- a/oso2pdf.cabal +++ b/oso2pdf.cabal @@ -1,7 +1,7 @@ name: oso2pdf version: 0.1.0 synopsis: Better conversion of Oxford Scholarship Online material to PDF -description: Please see README.md when I write it +description: Please see README.md homepage: https://github.com/spwhitton/oso2pdf license: GPL-3 license-file: LICENSE |