Skip to content

README clean up #67

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

Closed
kpgalligan opened this issue Apr 26, 2022 · 0 comments
Closed

README clean up #67

kpgalligan opened this issue Apr 26, 2022 · 0 comments
Assignees
Labels
cli Issues for the big rewrite

Comments

@kpgalligan
Copy link
Collaborator

The README is old and has a lot in it. I think it can be cleaned up:

Manually installing and updating the plugin can go in a different doc. The README should assume you're using the cli.

The "sources" discussion, and anything related to that can go in a different doc. I don't want to hide our roots, but main README should be pretty clean.

Same with "Future Stuff"

I think the update/repair should go right after install. Sort of go through the tool first, then go through using the plugin. There's a conflict there. What would the user likely do first vs keeping related topics together? Because the process of adding source is a little tricky, I think that needs to be expanded. The section on the cli can be shorter, so we can at least do install and repair in one block.

There's another ticket #65 for videos. The basic usage video should be the quick start instructions.

Still thinking through it, but I'd like to try the reformat.

@kpgalligan kpgalligan added the cli Issues for the big rewrite label Apr 26, 2022
@kpgalligan kpgalligan self-assigned this Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Issues for the big rewrite
Projects
None yet
Development

No branches or pull requests

1 participant