mirror of
https://github.com/JakeHillion/drgn.git
synced 2024-12-22 17:23:06 +00:00
Document PyPI package and installation with pip
This commit is contained in:
parent
18dfec083e
commit
f4822be904
11
README.rst
11
README.rst
@ -1,6 +1,10 @@
|
||||
drgn
|
||||
====
|
||||
|
||||
.. image:: https://img.shields.io/pypi/v/drgn
|
||||
:target: https://pypi.org/project/drgn/
|
||||
:alt: PyPI
|
||||
|
||||
.. image:: https://travis-ci.org/osandov/drgn.svg?branch=master
|
||||
:target: https://travis-ci.org/osandov/drgn
|
||||
:alt: Build Status
|
||||
@ -80,13 +84,10 @@ Then, run:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/osandov/drgn.git
|
||||
$ cd drgn
|
||||
$ python3 setup.py build
|
||||
$ sudo python3 setup.py install
|
||||
$ sudo pip3 install drgn
|
||||
|
||||
See the `installation documentation
|
||||
<https://drgn.readthedocs.io/en/latest/installation.html>`_ for more details.
|
||||
<https://drgn.readthedocs.io/en/latest/installation.html>`_ for more options.
|
||||
|
||||
Quick Start
|
||||
-----------
|
||||
|
@ -30,13 +30,30 @@ The build requires:
|
||||
:start-after: start-install-dependencies
|
||||
:end-before: end-install-dependencies
|
||||
|
||||
Then, drgn can be built and installed::
|
||||
The latest release of drgn can be installed globally with `pip
|
||||
<https://pip.pypa.io>`_::
|
||||
|
||||
$ sudo pip3 install drgn
|
||||
$ drgn --help
|
||||
|
||||
The development version can be built and installed manually::
|
||||
|
||||
$ git clone https://github.com/osandov/drgn.git
|
||||
$ cd drgn
|
||||
$ python3 setup.py build
|
||||
$ sudo python3 setup.py install
|
||||
$ drgn --help
|
||||
|
||||
Or, it can be be built and run locally::
|
||||
Both of these options can be done in a `virtual environment
|
||||
<https://docs.python.org/3/library/venv.html>`_ if you do not wish to install
|
||||
drgn globally::
|
||||
|
||||
$ python3 -m venv drgnenv
|
||||
$ source drgnenv/bin/activate
|
||||
(drgenv) $ pip3 install drgn
|
||||
(drgenv) $ drgn --help
|
||||
|
||||
For development, drgn can be built and run locally::
|
||||
|
||||
$ python3 setup.py egg_info build_ext -i
|
||||
$ python3 -m drgn --help
|
||||
|
Loading…
Reference in New Issue
Block a user