aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorWaylan Limberg <waylan.limberg@icloud.com>2017-12-08 20:13:06 -0500
committerWaylan Limberg <waylan.limberg@icloud.com>2017-12-08 20:46:24 -0500
commit193c5092b130a2e961e476982dc2d2d9c95623d2 (patch)
treef82575e1c60ff3343d3f318629e49eb034ae6e15 /docs
parent52b8da8e47c6dce643504f503c995c310b14bd19 (diff)
downloadmarkdown-193c5092b130a2e961e476982dc2d2d9c95623d2.tar.gz
markdown-193c5092b130a2e961e476982dc2d2d9c95623d2.tar.bz2
markdown-193c5092b130a2e961e476982dc2d2d9c95623d2.zip
Build and upload wheels for releases.
Update install docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/install.md63
1 files changed, 11 insertions, 52 deletions
diff --git a/docs/install.md b/docs/install.md
index d799797..25530d6 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -1,64 +1,25 @@
-title: Installation
+title: Installation
-Installing Python-Markdown
-==========================
+# Installing Python-Markdown
-The Easy Way
-------------
+## The Easy Way
-The easiest way to install Python-Markdown is simply to type one of the
-following commands from the command line as an Admin/Root user:
+The easiest way to install Python-Markdown is simply to type the
+following command from the command line:
```bash
pip install markdown
```
-or
-
-```bash
-easy_install markdown
-```
-
That's it! You're ready to [use](reference.md) Python-Markdown. Enjoy!
-Installing on Windows {: #windows }
------------------------------------
-
-Download the Windows installer (`.exe`) from
-[PyPI](http://pypi.python.org/pypi/Markdown)
-
-Double-click the file and follow the instructions.
-
-If you prefer to manually install Python-Markdown in Windows, download the
-Zip file, unzip it, and on the command line in the directory you unzipped to,
-run the following command:
-
-```text
-C://path/to/python.exe setup.py install
-```
-
-If you plan to use the provided command line script, you need to make sure your
-script directory is on your system path. On a typical Python install of Windows
-the Scripts directory is `C:\PythonXX\Scripts\` (were "XX" is the Python version
-number, i.e., "27"). Adjust the path according to your system and add to your
-system path.
-
-Installing on \*nix Systems {: #linux }
----------------------------------------
-
-From the command line do the following (where 2.x is the version number):
-
-```bash
-wget http://pypi.python.org/packages/source/M/Markdown/Markdown-2.x.tar.gz
-tar xvzf Markdown-2.x.tar.gz
-cd markdown-2.x/
-sudo python setup.py install
-```
+For more detailed instructions on installing Python packages, see the
+[Installing Packages] tutorial in the [Python Packaging User Guide].
-See [PyPI](http://pypi.python.org/pypi/Markdown) for all available versions.
+[Installing Packages]: https://packaging.python.org/tutorials/installing-packages/
+[Python Packaging User Guide]: https://packaging.python.org/
-Using the Git Repository {: #git }
-----------------------------------
+## Using the Git Repository {: #git }
If you're the type that likes to live on the edge, you may want to keep up with
the latest additions and bug fixes in the repository between releases.
@@ -67,7 +28,5 @@ get a copy of Python-Markdown from the repository do the following from the
command line:
```bash
-git clone git://github.com/Python-Markdown/markdown.git python-markdown
-cd python-markdown
-python setup.py install
+pip install git+https://github.com/Python-Markdown/markdown.git
```