Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add install instructions to README #28

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

toadjaune
Copy link

Hi there,

The README mentions that this project relies on pyobjc to work, but doesn't explicitly state that this is a dependency that needs to be manually installed, nor how.

Similarly, it's not obvious in the README that this project requires being on MacOS to work (I first tried it on Linux, where I got an explicit error: PyObjC requires macOS to build error).

I thought putting together a (very basic) install doc could potentially save some trial and error to future users, so, here it is !
Feel free to change or reorganize it as you see fit, and thanks for this project :)

@toadjaune
Copy link
Author

For the record : I just tried using this script on a freshly-installed Mac, running MacOS 14.4.1, and those instructions, combined with #27 , were enough to make it work.

No need to manually install a different python version, or anything fancy, just a shebang change and a pip install.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant