Skip to content

Added some docs on plugins. #500

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Miro-Andrin
Copy link
Contributor

@Miro-Andrin Miro-Andrin commented Sep 30, 2021

Started on docs for plugins with help from @Tracreed .

Once that is setup, locate the folder `feather/quill/cargo_quill` in a terminal. Then run the following command.

```bash
cargo install --path <path to quill>
Copy link

@tim-kt tim-kt Oct 1, 2021

Choose a reason for hiding this comment

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

What is <path to quill>? Do I need to build cargo-quill first?

Copy link
Contributor Author

@Miro-Andrin Miro-Andrin Oct 1, 2021

Choose a reason for hiding this comment

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

Yes, If i change it to cargo-quill, does that spark joy?

Copy link

@tim-kt tim-kt Oct 1, 2021

Choose a reason for hiding this comment

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

I'm just not sure why you're using a placeholder. You could say "In the root directory of feather, run the following command" followed by cargo install --path quill/cargo_quill/ or you could also say "Navigate into quill/cargo_quill and run the following command", followed by cargo install --path ..

@tim-kt
Copy link

tim-kt commented Oct 1, 2021

I've submitted some wording changes, nothing too major. What's missing for me as an outsider is what the plugin should look like after I create it with cargo-quill (to see if I made a mistake or not) and what the general structure of a plugin is (Plugin trait, implementing this trait, systems, etc).

@Miro-Andrin
Copy link
Contributor Author

Agree, but we ran out of energy before we got that far.

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.

3 participants