Skip to content
This repository has been archived by the owner on Jul 24, 2019. It is now read-only.

Commit

Permalink
better installation documentation, including dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
iandennismiller committed Sep 29, 2016
1 parent 7221e2d commit 0922ae9
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 16 deletions.
2 changes: 1 addition & 1 deletion Makefile
Expand Up @@ -16,7 +16,7 @@ clean:
find . -name __pycache__ -delete

docs:
rm -rf build/sphinx
# rm -rf build/sphinx
sphinx-build -b html docs build/sphinx

watch:
Expand Down
27 changes: 14 additions & 13 deletions Readme.rst
Expand Up @@ -24,33 +24,34 @@ Overview

Pub2 is a self-publishing framework. It integrates with Jekyll to provide LaTeX publishing.

Installation
^^^^^^^^^^^^
macOS Quick Start
^^^^^^^^^^^^^^^^^

Homebrew
~~~~~~~~
The following commands install pub2 and its dependencies (TeX Live and ImageMagick).

::

brew install https://raw.githubusercontent.com/iandennismiller/pub2/master/etc/pub2.rb
brew cask install mactex
brew install https://raw.githubusercontent.com/iandennismiller/pub2/master/etc/pub2.rb

Python pip
~~~~~~~~~~
To demonstrate pub2, the following commands initialize the current directory and build a sample. The results appear in the `pub2` folder.

::

pip install pub2
pub2 init
pub2 build
open pub2/*.pdf

Usage
^^^^^
Installation
^^^^^^^^^^^^

Create a new folder and switch to it. The following will initialize the folder and render a sample document.
pub2 can be installed using pip. This works well with virtualenv.

::

pub2 init
pub2 build
pip install pub2

See :doc:`installation` to install on macOS, Windows, and Linux (Debian/Ubuntu or Redhat/CentOS).

Documentation
^^^^^^^^^^^^^
Expand Down
6 changes: 4 additions & 2 deletions docs/index.rst
@@ -1,9 +1,11 @@
.. include:: ../Readme.rst

Introduction
------------
About
-----

.. toctree::
:maxdepth: 1

installation
license
changelog
58 changes: 58 additions & 0 deletions docs/installation.rst
@@ -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

0 comments on commit 0922ae9

Please sign in to comment.