summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJuan J. Martínez <jjm@usebox.net>2019-07-27 10:52:58 +0100
committerGitHub <noreply@github.com>2019-07-27 10:52:58 +0100
commit5797d6d4aaf6bd6155a4312f3d7ca4ad251b190a (patch)
tree91abced97331d5d40088419f424952f99f6457ed /README.md
parent12b94cec43b00be6c48c865602c642927ad55f86 (diff)
parent2cfc3a0828e76af363c7185403076c3782e52ed5 (diff)
downloadz80count-5797d6d4aaf6bd6155a4312f3d7ca4ad251b190a.tar.gz
z80count-5797d6d4aaf6bd6155a4312f3d7ca4ad251b190a.zip
Merge pull request #4 from patxoca/master
Package z80count as a python distribution
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index 56be7a5..ccbd7e1 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,19 @@ and adds comments to the code with the cycles used by the instruction.
It needs testing and probably a proper Z80 parser, but it works for me and the
Z80 assembler syntax I use.
-![Demo with vim](./demo-vim.gif)
+![Demo with vim](./etc/demo-vim.gif)
+
+## Installation
+
+To install for production download the package from [z80count's releases tab](https://github.com/reidrac/z80count/releases), unpack and run:
+
+ python setup.py install
+
+To install for developmet run:
+
+ git clone https://github.com/reidrac/z80count.git
+ cd z80count
+ pip install -e ".[dev]"
## Requirements
@@ -144,4 +156,3 @@ Feel free to open a PR if you find a bug!
- Juan J. Martinez <jjm@usebox.net>
- Alexis Roda (https://github.com/patxoca)
-