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

readme: add link to hubris #392

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

will
Copy link

@will will commented Jun 8, 2023

There was a link to Humility in a blog post, and since it wasn't the point of the blog post that post did not explain what Humility was. So I clicked that link and came to this repo. This repo's readme says that it's a debugger for Hubris and assumes you know what Hubris is, which I would argue is hubris in and of itself. I had no idea what it was. I took a lucky guess that it would be another project on the same org and was correct. I think that hyperlink to that other project would be both an easy and natural way for others to not have to make that same guess.

@bcantrill bcantrill changed the title readme: add link to huburis readme: add link to hubris Jun 8, 2023
Copy link
Contributor

@bcantrill bcantrill left a comment

Choose a reason for hiding this comment

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

Looks great -- thank you!

@bcantrill
Copy link
Contributor

bcantrill commented Jun 8, 2023

Looks great -- thank you!

Actually, to amend that: you need to run cargo xtask readme to generate the actual README.

@will
Copy link
Author

will commented Jun 8, 2023

Oh okay. That means I'll have to actually check this out. One second

@will
Copy link
Author

will commented Jun 8, 2023

edit: ignore this. I didn't read close enough the command you said to run, sorry

original post:

Is there a step to get cargo to learn of the custom commands?

❯ nix run nixpkgs#cargo -- version
cargo 1.69.0
❯ nix run nixpkgs#cargo -- readme
error: no such command: `readme`

	Did you mean `remove`?

	View all installed commands with `cargo --list`
❯ nix run nixpkgs#cargo -- --list
Installed Commands:
    add                  Add dependencies to a Cargo.toml manifest file
    b                    alias: build
    bench                Execute all benchmarks of a local package
    build                Compile a local package and all of its dependencies
    c                    alias: check
    check                Check a local package and all of its dependencies for errors
    clean                Remove artifacts that cargo has generated in the past
    config               Inspect configuration values
    d                    alias: doc
    doc                  Build a package's documentation
    fetch                Fetch dependencies of a package from the network
    fix                  Automatically fix lint warnings reported by rustc
    generate-lockfile    Generate the lockfile for a package
    git-checkout         This command has been removed
    help                 Displays help for a cargo subcommand
    init                 Create a new cargo package in an existing directory
    install              Install a Rust binary. Default location is $HOME/.cargo/bin
    locate-project       Print a JSON representation of a Cargo.toml file's location
    login                Save an api token from the registry locally. If token is not specified, it will be read from stdin.
    logout               Remove an API token from the registry locally
    metadata             Output the resolved dependencies of a package, the concrete used versions including overrides, in machine-readable format
    new                  Create a new cargo package at <path>
    owner                Manage the owners of a crate on the registry
    package              Assemble the local package into a distributable tarball
    pkgid                Print a fully qualified package specification
    publish              Upload a package to the registry
    r                    alias: run
    read-manifest        Print a JSON representation of a Cargo.toml manifest.
    remove               Remove dependencies from a Cargo.toml manifest file
    report               Generate and display various kinds of reports
    rm                   alias: remove
    run                  Run a binary or example of the local package
    rustc                Compile a package, and pass extra options to the compiler
    rustdoc              Build a package's documentation, using specified custom flags.
    search               Search packages in crates.io
    t                    alias: test
    test                 Execute all unit and integration tests and build examples of a local package
    tree                 Display a tree visualization of a dependency graph
    uninstall            Remove a Rust binary
    update               Update dependencies as recorded in the local lock file
    vendor               Vendor all dependencies for a project locally
    verify-project       Check correctness of crate manifest
    version              Show version information
    xtask                alias: run --package xtask --
    yank                 Remove a pushed crate from the index

@will will force-pushed the patch-1 branch 2 times, most recently from d0c55de to d0c5720 Compare June 8, 2023 18:28
There was a link to Humility in a blog post, and since it wasn't the point of the blog post that post did not explain what Humility was. So I clicked that link and came to this repo. This repo's readme says that it's a debugger for Hubris and assumes you know what Hubris is, which I would argue is hubris in and of itself. I had no idea what it was. I took a lucky guess that it would be another project on the same org and was correct. I think that hyperlink to that other project would be both an easy and natural way for others to not have to make that same guess.
@will
Copy link
Author

will commented Jun 8, 2023

I tried. It added my new link, but then deleted the last 2/3 of the readme, and I'm not sure why, so I manually did the change.

I enjoyed your "don't anthropomorphize the lawnmower" digression, by the way

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.

2 participants