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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for v0.2.0 #56

Closed
13 tasks done
chshersh opened this issue Aug 30, 2022 · 0 comments · Fixed by #101
Closed
13 tasks done

Improve documentation for v0.2.0 #56

chshersh opened this issue Aug 30, 2022 · 0 comments · Fixed by #101
Assignees
@chshersh
Labels
documentation Improvements or additions to documentation
Milestone
v0.2.0: Improved ...

Comments

@chshersh
Copy link
Owner

chshersh commented Aug 30, 2022 •
edited
Loading

@chshersh chshersh added the documentation Improvements or additions to documentation label Aug 30, 2022
@chshersh chshersh added this to the v0.2.0: Improved sync milestone Aug 30, 2022
@chshersh chshersh mentioned this issue Aug 31, 2022
Closed
@chshersh chshersh changed the title Add comparison with 'cargo binstall' Add comparison with more tools Sep 2, 2022
@chshersh chshersh self-assigned this Sep 2, 2022
@chshersh chshersh changed the title Add comparison with more tools Improve documentation for v0.2.0 Sep 15, 2022
chshersh added a commit that referenced this issue Sep 19, 2022
@chshersh
[#56] Improve documentation for v0.2.0
d848afc 
Resolves #56
@chshersh chshersh mentioned this issue Sep 19, 2022
Merged
2 tasks
chshersh added a commit that referenced this issue Sep 20, 2022
@chshersh
[#56] Improve documentation for v0.2.0
724484c 
Resolves #56
chshersh added a commit that referenced this issue Sep 20, 2022
@chshersh @zixuan-x
[#56] Improve documentation for v0.2.0 (#101)
89a7be2 
Resolves #56

I've improved the documentation for `tool-sync` in a few ways:

* Rewrote README
* Added a CHAGELOG
* Slightly changed the CONTRIBUTING.md guide (now it requires to add new
changes in the changelog)
* Generated a new GIF with the new output
* Increased the version to `0.2.0`

I want to implement #54 and #55 before actually creating a release so
the CHANGELOG will change. But those changes shouldn't affect the
documentation so this one can be merged separately.

### Additional tasks

- [x] Documentation for changes provided/changed
- [ ] Tests added

Co-authored-by: Zixuan Zhang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chshersh chshersh

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.2.0: Improved sync + install
Development

Successfully merging a pull request may close this issue.

[#56] Improve documentation for v0.2.0 chshersh/tool-sync
1 participant
@chshersh