Skip to content

Commit

Permalink
Release version 0.3.
Browse files Browse the repository at this point in the history
Fixed a couple typos and such in the README.
  • Loading branch information
Rex-- committed Oct 6, 2022
1 parent ad21f20 commit 383fe33
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 14 deletions.
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,38 +27,46 @@ to be programmed. Currently, picchick supports two programmers:

## Installation

<!-- Device files from Microchip are needed to extract interesting memory addresses for specific chips, e.g.
the Configuration Words or Device Information Area. These device files are -->

### Requirements
- **`xc8` compiler installed to one of**:
> (linux) /opt/microchip/xc8/ \
> (Windows) c:\Program Files (x86)\Microchip\xc8\ *\*Windows not currently Supported*
- **`xc8` compiler**
- Available from [Microchip's website](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/downloads-documentation)

- **python >= 3.10**
- **`python` >= 3.10**
- pyserial

- **Compatible serial programmer**
- See above for information about programmers.


#### From PyPi
### From PyPi
`picchick` can be installed using pip:
```
pip install picchick
<...>
picchick -h
```

#### From Source
`picchick` can also be run as a python module:
### From Source
Building the latest git version is as simple as pip installing the repo
directory. The -e, --editable flag can be added so a `git pull` will update the
`picchick` command automatically.
```sh
git clone https://github.com/Rex--/picchick.git
cd picchick/
pip install [-e] .
picchick -h
```
python -m picchick -h

Instead of installing the package, `picchick` can also be run as a python module:
```
A wrapper script is also provided:
python -m picchick -h
```
A wrapper script is provided that does this, providing a bit cleaner interface:
```sh
chmod +x picchick.sh
./picchick.sh -h
```
NOTE: You may have to install pyserial for the above methods.

## Usage
```
Expand Down
2 changes: 1 addition & 1 deletion picchick/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ def parseArgv():

# Check if port exists
if args.port is None:
print("Missing argument: -p port")
print("Missing argument: -P port")
sys.exit(1)
elif not os.path.exists(args.port):
print(f"Could not find port: { args.port }")
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = picchick
version = 0.2.2
version = 0.3.0
author = Rex McKinnon
author_email = 0xff@rexploits.com
description = A utility for programming PIC microntronllers.
Expand Down

0 comments on commit 383fe33

Please sign in to comment.