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

docs/crow/scripting: Update druid install/usage instructions #142

Merged
merged 1 commit into from
Oct 9, 2019

Conversation

simonvanderveldt
Copy link
Member

@simonvanderveldt simonvanderveldt commented Oct 9, 2019

Updates to the docs to match the changes in monome/druid#25

Might even make it to publish to pypi today, if I do I'll create another PR to update the docs.

pip3 install .
```

Now druid should be ready to use, you might need to close and reopen the terminal to get access to it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pip will warn you here if the binary location is not on your path, but it might be good to draw attention to that warning message?

Copy link
Member Author

@simonvanderveldt simonvanderveldt Oct 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean when ~/.local/bin or /usr/local/bin isn't on $PATH?
The hint I added here was more for tab-completion (as in someone expecting dr<tab> to show them druid but it isn't happening), but that's also a valid point. On the other hand if pip already tells the user do we need to document it as well?

Copy link
Collaborator

@trentgill trentgill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. The scripting doc will need to be updated though as we no longer know the local folder.

This also means that r and u can't use a default file (was druid/sketch.lua) unless we add some fancy behaviour to track recently uploaded files.

We're making a repo today (github.com/monome/bowery) that will house user-submitted crow scripts (including the druid examples), so i guess we should get that up asap & change the docs to reflect that setup.

@tehn tehn merged commit a740a72 into master Oct 9, 2019
@tehn tehn deleted the druid-install-instructions-part1 branch October 9, 2019 19:29
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.

4 participants