Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme update #53

Closed
wants to merge 3 commits into from
Closed

Readme update #53

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b07cee
included virtualenv in installation guide
ezdac Feb 23, 2016
fe73368
included virtualenv in installation guide
ezdac Feb 23, 2016
01b324e
switched to install instructions with pip
ezdac Feb 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,37 @@ Setup & Invocation

**Installation**

> git clone https://github.com/HydraChain/hydrachain
> cd hydrachain
> python setup.py develop
The basic requirement for the HydraChain to run is the use of Python 2.7. If you're OS isn't shipping with a pre-installed, up-to-date version of Python 2.7 and you don't know how to install Python, have a look [here](https://wiki.python.org/moin/BeginnersGuide/Download). It is always easier to let a package manager (e.g. `homebrew` on Mac OS X, `apt` on Debian) handle your installations.

Please install the `virtualenv` environment for a proper working Hydrachain installation. Also, it is always recommended to use it in combination with the `virtualenvwrapper` extension.


```
> pip install virtualenv

> pip install virtualenvwrapper
```

Make sure that you create a virtual environment for your installation and always activate it when you work on the Hydrachain app.

For the `virtualenvwrapper`:

```
> mkvirtualenv Hydrachain

```

You are now ready to install Hydrachain, either via `git clone`,
or - more conveniently - with the `pip install` command inside your _virtualenv_.

```
> workon Hydrachain
(Hydrachain)

> pip install hydrachain
```

To update your version of Hydrachain, simply run the `pip install` command again.


**Multiple nodes in a single process**
Expand Down Expand Up @@ -106,7 +134,7 @@ See the [Dockerfile templates](https://github.com/HydraChain/hydrachain/tree/mas

Status: Work in Progress
------------------------
- 16.01.2016 - v0.1.10 - Automate docker image creation
- 16.01.2016 - v0.1.10 - Automate docker image creation
- 27.11.2015 - v0.1.0 - Automate PyPI release process
- 26.11.2015 - v0.0.7 - Various fixes; first PyPI release
- 21.11.2015 - v0.0.6 - Various fixes
Expand Down