This repository has been archived by the owner on Jul 24, 2019. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
better installation documentation, including dependencies
- Loading branch information
1 parent
7221e2d
commit 0922ae9
Showing
4 changed files
with
77 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,11 @@ | ||
.. include:: ../Readme.rst | ||
|
||
Introduction | ||
------------ | ||
About | ||
----- | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
installation | ||
license | ||
changelog |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
Installation | ||
============ | ||
|
||
pub2 depends on TeX Live and ImageMagick. To install, use either Homebrew (OSX) or pip (OSX, Linux, or Windows). | ||
|
||
OSX Homebrew | ||
^^^^^^^^^^^^ | ||
|
||
This is the suggested install method on OSX. | ||
|
||
:: | ||
|
||
brew cask install mactex | ||
brew install https://raw.githubusercontent.com/iandennismiller/pub2/master/etc/pub2.rb | ||
|
||
OSX pip | ||
^^^^^^^ | ||
|
||
The pip method works well with virtualenv. For system-wide installation, use the homebrew method if possible. | ||
|
||
Install mactex and imagemagick, then pub2. | ||
|
||
:: | ||
|
||
brew cask install mactex | ||
brew install imagemagick | ||
pip install pub2 | ||
|
||
Linux (Debian/Ubuntu) | ||
^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
Install magickwand-dev and texlive, then pub2. Use virtualenv if you want. | ||
|
||
:: | ||
|
||
apt-get install libmagickwand-dev texlive | ||
pip install pub2 | ||
|
||
Linux (Redhat/CentOS) | ||
^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
Install imagemagck and texlive, then pub2. Use virtualenv if you want. | ||
|
||
:: | ||
|
||
yum install ImageMagick-devel texlive-latex | ||
pip install pub2 | ||
|
||
Windows | ||
^^^^^^^ | ||
|
||
1. Install TeX: http://mirror.ctan.org/systems/texlive/tlnet/install-tl-windows.exe | ||
2. Install ImageMagick: http://docs.wand-py.org/en/0.4.3/guide/install.html#install-imagemagick-on-windows | ||
3. Think happy thoughts. | ||
|
||
:: | ||
|
||
pip install pub2 |