aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexis Roda <alexis.roda.villalonga@gmail.com>2019-07-27 10:09:52 +0200
committerAlexis Roda <alexis.roda.villalonga@gmail.com>2019-07-27 10:09:52 +0200
commit5f7d94e32812cb02ecde0a9f4fa965002f551c86 (patch)
treeeeffe933a08e3084db2ff0d407e510cf58596d66 /README.md
parent3556d259a249135c326fc518100b00829f8f8815 (diff)
downloadz80count-5f7d94e32812cb02ecde0a9f4fa965002f551c86.tar.gz
z80count-5f7d94e32812cb02ecde0a9f4fa965002f551c86.zip
Make a python package.
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..72b9140 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)
-