-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.rst.in
86 lines (57 loc) · 2.96 KB
/
README.rst.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
.. _header_section:
expak: Extract and process resources from Quake-style pak files
===============================================================
.. image:: http://img.shields.io/pypi/v/expak.svg
:target: https://pypi.python.org/pypi/expak
:alt: current version
.. image:: http://img.shields.io/travis/neogeographica/expak.svg
:target: http://travis-ci.org/neogeographica/expak
:alt: build status of the master branch
.. _blurb_section:
.. include:: docs/blurb.txt
.. _prerequisites_section:
Prerequisites
-------------
It's a Python module and utility, so you need Python! If you don't have Python
installed, `go get it`_. The latest stable version of either Python 2 or Python 3
will work. (And if you're already a fan of `PyPy`_, expak works with that too.)
You'll probably also want a Python package manager to help install expak (and
other things). If you're going to be running on Windows, you can skip this
part by downloading a custom expak installer as described below ... although
even on Windows, it can be convenient to have a Python package manager, so you
may want to take care of this anyway.
The `pip`_ package manager is a fine choice for anyone running Python 2.6 or
later. If you don't currently have pip then you can run through the
`instructions for installing pip`_ and be good to go; it can do many things,
but you can ignore all of its complexity for the purposes of installing expak.
.. _go get it: http://python.org/download/
.. _PyPy: http://pypy.org/
.. _pip: http://www.pip-installer.org/en/latest
.. _instructions for installing pip: http://www.pip-installer.org/en/latest/installing.html
.. _installation_section:
Installation
------------
The latest version of expak can always be installed or updated to via the `pip`_
package manager, and this is the preferred method:
.. code-block:: none
pip install expak
The easy_install utility can also install expak, if you have setuptools
installed but can't or don't want to use pip:
.. code-block:: none
easy_install expak
Finally, if you are on Windows, you could also choose to use an installer
program, although the methods above work fine on Windows. Custom expak
installers are included in the downloads list for expak
`at the Python Package Index`_ (PyPI).
If PyPI is down, the above installer commands and links won't work. PyPI has
good uptime these days, but if for some reason you do have a problem reaching
it, the Windows installers and other forms of distribution files (including
source distribution) are mirrored `in the releases for the GitHub repo`_.
Another alternative to relying on PyPI, if you have if you have both pip and
git installed, is to install expak directly from GitHub:
.. code-block:: none
pip install git+https://github.com/neogeographica/expak
.. _at the Python Package Index: https://pypi.python.org/pypi/expak
.. _in the releases for the GitHub repo: https://github.com/neogeographica/expak/releases
.. _documentation_section:
.. include:: docs/rtdlinks.txt