File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -27,38 +27,46 @@ to be programmed. Currently, picchick supports two programmers:
2727
2828## Installation
2929
30- <!-- Device files from Microchip are needed to extract interesting memory addresses for specific chips, e.g.
31- the Configuration Words or Device Information Area. These device files are -->
32-
3330### Requirements
34- - ** ` xc8 ` compiler installed to one of** :
35- > (linux) /opt/microchip/xc8/ \
36- > (Windows) c:\Program Files (x86)\Microchip\xc8\ * \* Windows not currently Supported*
31+ - ** ` xc8 ` compiler**
32+ - Available from [ Microchip's website] ( https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/downloads-documentation )
3733
38- - ** python >= 3.10**
34+ - ** ` python ` >= 3.10**
3935 - pyserial
4036
4137- ** Compatible serial programmer**
4238 - See above for information about programmers.
4339
4440
45- #### From PyPi
41+ ### From PyPi
4642` picchick ` can be installed using pip:
4743```
4844pip install picchick
4945<...>
5046picchick -h
5147```
5248
53- #### From Source
54- ` picchick ` can also be run as a python module:
49+ ### From Source
50+ Building the latest git version is as simple as pip installing the repo
51+ directory. The -e, --editable flag can be added so a ` git pull ` will update the
52+ ` picchick ` command automatically.
53+ ``` sh
54+ git clone https://github.com/Rex--/picchick.git
55+ cd picchick/
56+ pip install [-e] .
57+ picchick -h
5558```
56- python -m picchick -h
59+
60+ Instead of installing the package, ` picchick ` can also be run as a python module:
5761```
58- A wrapper script is also provided:
62+ python -m picchick -h
5963```
64+ A wrapper script is provided that does this, providing a bit cleaner interface:
65+ ``` sh
66+ chmod +x picchick.sh
6067./picchick.sh -h
6168```
69+ NOTE: You may have to install pyserial for the above methods.
6270
6371## Usage
6472```
Original file line number Diff line number Diff line change @@ -172,7 +172,7 @@ def parseArgv():
172172
173173 # Check if port exists
174174 if args .port is None :
175- print ("Missing argument: -p port" )
175+ print ("Missing argument: -P port" )
176176 sys .exit (1 )
177177 elif not os .path .exists (args .port ):
178178 print (f"Could not find port: { args .port } " )
Original file line number Diff line number Diff line change 11[metadata]
22name = picchick
3- version = 0.2.2
3+ version = 0.3.0
44author = Rex McKinnon
55author_email = 0xff@rexploits.com
66description = A utility for programming PIC microntronllers.
You can’t perform that action at this time.
0 commit comments