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

CLI Book – Rolling Review – DO NOT MERGE #58

wants to merge 229 commits into
base: pls-review

CLI Book – Rolling Review – DO NOT MERGE #58

wants to merge 229 commits into from


Copy link

killercup commented Aug 1, 2018

This pull request is not meant to ever be merged.

The book is written like this: New chapters will be added in PRs, where they get a bit of review, and finally get merged into master. Once they land in master, it's hard to leave review comments, though!

This PR is meant to give you a way to review the book and leave comments in an easy way. It shows the diff between master before I added the book and master right now, so it'll always show the full book, and also automatically mark comments as resolved once new content lands in master.

killercup added 30 commits Jul 25, 2018
Ive already added the GITHUB_TOKEN
Just to draft out a possible book structure
mdbook setup and draft of tutorial
Renders nicely on github
These are rendered as separate pages so it makes sense to have an h1 on
each one of them.
More book content
Not meant to replace the book chapter, just wants to provide an
alternative perspective on this in the context of CLI apps.
Tutorial: Draft of Output chapter
howaboutsynergy and others added 30 commits Jun 8, 2019
Fix typo
- Add link to confy crate in "Using config files" section.
Use code blocks instead of indented normal text;
before, backticks were not displayed correctly.
Add missing "the"; use "it would" instead of contraction "it'd".
Drop unnecessary comments in shell sessions
Fix typo and style
Add URL to the git repository for the book
Remove superfluous empty line and fix typo
Misc. link additions.
* Add intro text to in-depth section

* Bump mdbook version to 0.3.5

* Update dependencies

Just to make sure they still work. Also adds actual commit hash to git
Links from changed to 1.39.0.
Linked content largely unchanged, so nothing further needed.

One link also had a chapter title change ("Packages, Crates, and
Modules" is now "Managing Growing Projects with Packages, Crates, and
Modules"), so name of the link changed with it.

Fixes #156
As of version 0.11.0, the assert_cmd crate has dropped the
`main_binary()` function in favor of `cargo_bin()` that takes the name
of the cargo binary. Update the testing chapter of the book to use
`cargo_bin("grrs")` with the binary name hard coded. Another option
would be to use `cargo_bin(env!("CARGO_PKG_NAME"))` if you briefly
wanted to explain cargo's environmental variables and the `env!()` macro.
Make it clear source is edited in src/ and where source parts are positioned.
Help newbies by claryfying this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
You can’t perform that action at this time.