This PR contains two modifications to the project README.md:
According to the Python.org page's release notes for Python 3.9, that was the first version that supported native Apple ARM64 silicon. While there may be a way to build previous versions for Apple M[1-3] systems, I was running into a lot of build issues on Python versions 3.7 & 3.8 relating to ctypes and libffi, which posts on Stack Overflow suggested either updating to a new Python minor version, or modifying some system library scripts.
I wrote a package.yml for opencanaryd to run via pkgx, which should allow for install-less use natively on Linux and MacOS targets on both AMD64 and ARM64 (only tested on Linux, but the CI/CD pipeline verified it can at least run the --version option on all platforms). I added the documentation for how to use it into README.md.
Types of changes
What types of changes does your code introduce to this repository?
Put an x in the boxes that apply
[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation Update
Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
[ ] Lint and unit tests pass locally with my changes (if applicable)
[ ] I have run pre-commit (pre-commit in the repo)
[ ] I have added tests that prove my fix is effective or that my feature works
[x] I have added necessary documentation (if appropriate)
[ ] Linked to the relevant github issue or github discussion
Proposed changes
This PR contains two modifications to the project README.md:
--versionoption on all platforms). I added the documentation for how to use it into README.md.Types of changes
What types of changes does your code introduce to this repository? Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.pre-commitin the repo)