diff --git a/README.md b/README.md index 71f7af6..0f67b78 100644 --- a/README.md +++ b/README.md @@ -27,22 +27,18 @@ to be programmed. Currently, picchick supports two programmers: ## Installation - - ### 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 @@ -50,15 +46,27 @@ 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 ``` diff --git a/picchick/cli.py b/picchick/cli.py index 598508d..af07f26 100755 --- a/picchick/cli.py +++ b/picchick/cli.py @@ -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 }") diff --git a/setup.cfg b/setup.cfg index 7263f66..8d71cb5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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.