Skip to content

Commit ca0844c

Browse files
committed
Make quickstart slightly more useful
1 parent d0c44cf commit ca0844c

File tree

1 file changed

+51
-5
lines changed

1 file changed

+51
-5
lines changed

docs/guides/quickstart.rst

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,61 @@
11
Quickstart
22
==========
33

4+
Installation
5+
~~~~~~~~~~~~
6+
7+
This guide teaches how to use Py-EVM as a library. For contributors, please check out the
8+
:doc:`Contributing Guide </contributing>` which explains how to set everything up for development.
9+
10+
11+
Installing on Ubuntu
12+
--------------------
13+
14+
Py-EVM requires Python 3.6 as well as some tools to compile its dependencies. On Ubuntu, the
15+
``python3.6-dev`` package contains everything we need. Run the following command to install it.
16+
17+
.. code:: sh
18+
19+
apt-get install python3.6-dev
20+
21+
Py-EVM is installed through the pip package manager, if pip isn't available on the system already,
22+
we need to install the ``python3-pip`` package through the following command.
23+
24+
.. code:: sh
25+
26+
apt-get install python3-pip
27+
428
.. note::
29+
.. include:: /fragments/virtualenv_explainer.rst
30+
31+
Finally, we can install the ``py-evm`` package via pip.
532

6-
This quickstart is aspirational. The code examples may not work
7-
yet.
33+
.. code:: sh
834
35+
pip3 install -U trinity
936
10-
Installation
11-
------------
37+
Installing on macOS
38+
-------------------
39+
40+
First, install Python 3 with brew:
41+
42+
.. code:: sh
43+
44+
brew install python3
45+
46+
.. note::
47+
.. include:: /fragments/virtualenv_explainer.rst
48+
49+
Then, install the ``py-evm`` package via pip:
1250

1351
.. code:: sh
1452
15-
pip install py-evm
53+
pip3 install -U py-evm
54+
55+
56+
.. hint::
57+
58+
:doc:`Build a first app </guides/building_an_app_that_uses_pyevm>` on top of Py-EVM in under
59+
5 minutes
60+
61+

0 commit comments

Comments
 (0)