Skip to content

Commit

Permalink
Updating install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tgsmith61591 committed Oct 13, 2016
1 parent 893aee8 commit 61a2540
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,20 @@ sudo apt-get install gcc


### Installation:

Installation is easy. After cloning the project onto your machine, simply use the `setup.py` file:

```bash
git clone https://github.com/tgsmith61591/skutil.git
cd skutil
python setup.py install
```


#### Testing:

If you'd like to fork skutil and will be running some tests, your setup is a bit different. Rather than using the `install` arg, use `develop`. This creates a symlink in the local directory so that as you make changes, they are automatically reflected and you don't have to re-install every time. For more information on `develop` vs. `install`, see [this](http://stackoverflow.com/questions/19048732/python-setup-py-develop-vs-install) StackOverflow question. Note that after running setup with `develop`, you may have to uninstall before re-running with `install`. *If you are experiencing the dreaded* `no module named dqrsl` *issue and your GCC is up-to-date, it's likely a* `develop` *vs.* `install` *issue. Try uninstalling, clearing the egg from the local folder (or popping the local path from* `sys.path`*) and running setup with the* `install` *option.*

```bash
git clone https://github.com/tgsmith61591/skutil.git
cd skutil
Expand Down

0 comments on commit 61a2540

Please sign in to comment.