Skip to content

Commit b85a15f

Browse files
committed
Add "Getting Started" instructions to the readme
1 parent dbdd399 commit b85a15f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,34 @@ Comprehensive documentation can be found [here](http://prestodb.github.io/presto
2828
Presto-admin makes use of `make` as its build tool. `make` in turn calls out to various utilities (e.g.
2929
`tox`, `flake8`, `sphinx-apidoc`, `python`) in order to perform the requested actions.
3030

31+
In order to get started with `presto-admin`,
32+
1. Fork the `presto-admin` repo on GitHub, https://github.com/prestodb/presto-admin.
33+
2. Clone your fork locally::
34+
35+
$ git clone [email protected]:your_name_here/presto-admin.git
36+
37+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
38+
39+
$ mkvirtualenv prestoadmin
40+
$ cd prestoadmin/
41+
$ python setup.py develop
42+
43+
4. Create a branch for local development::
44+
45+
$ git checkout -b name-of-your-bugfix-or-feature
46+
47+
Now you can make your changes locally.
48+
49+
5. When you're done making changes, check that your changes pass `make clean lint test`, which runs flake8 and the unit tests (which test both Python 2.6 and 2.7).
50+
To run the product tests tests (`make test-all`), you need docker installed. You may also need to run `pip install wheel` in your virtualenv. To install and start docker use::
51+
52+
$ wget -qO- https://get.docker.com/ | sh
53+
54+
# Add current user to Docker group to run without sudo
55+
$ sudo gpasswd -a ${USER} docker
56+
$ sudo service docker restart
57+
58+
3159
### Building the installer
3260

3361
The two tasks used to build the presto-admin installer are `dist` and

0 commit comments

Comments
 (0)