From 5f7d94e32812cb02ecde0a9f4fa965002f551c86 Mon Sep 17 00:00:00 2001 From: Alexis Roda Date: Sat, 27 Jul 2019 10:09:52 +0200 Subject: Make a python package. --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'README.md') 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 - Alexis Roda (https://github.com/patxoca) - -- cgit v1.2.3 From 11cb2bb14a83dfb16293d7ff072e2c170ec73ebc Mon Sep 17 00:00:00 2001 From: Alexis Roda Date: Sat, 27 Jul 2019 10:16:05 +0200 Subject: Fix markdown. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 72b9140..ccbd7e1 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ Z80 assembler syntax I use. 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 + python setup.py install To install for developmet run: - git clone https://github.com/reidrac/z80count.git - cd z80count - pip install -e ".[dev]" + git clone https://github.com/reidrac/z80count.git + cd z80count + pip install -e ".[dev]" ## Requirements -- cgit v1.2.3