Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
cnvogelg committed Apr 13, 2021
1 parent d26218f commit 9d5c1f2
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ pacman -S mingw-w64-x86_64-python2-pip mingw-w64-x86_64-gcc git make

### The Easy Way for Users

#### Release Version

```bash
pip3 install amitools
```
Expand All @@ -118,6 +120,15 @@ Note:
- on Linux/macOS may use ``sudo`` to install for all users
- requires a host C compiler to compile the extension.

#### Current Version from GitHub

```bash
pip3 install -U git+https://github.com/cnvogelg/amitools.git
```

This will install the latest version found in the github repository.
You find the latest features but it may also be unstable from time to time.

### Developers

- Follow this route if you want to hack around with the amitools codebase
Expand Down Expand Up @@ -160,7 +171,14 @@ python3 setup.py build_ext -i
or if you have installed `GNU make` simply use:

```bash
make
make init # global or virtualenv setup
make init_user # user setup
```

For more help on the `make` targets run:

```bash
make help
```

## Contents
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
ext_file = "musashi/emu.c"
if not os.path.exists(ext_file) and not use_cython:
print("generated cython file missing! cython is essential to proceed!")
print("please install with: pip install cython")
print("please install with: pip3 install cython")
sys.exit(1)


Expand Down

0 comments on commit 9d5c1f2

Please sign in to comment.