jgarzik / jgarzik/brainpro

Improve usage instructions.

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
49
Forks
6
PR merge metrics
No merged PRs in 30d

Description

The instructions [imply](https://github.com/jgarzik/brainpro?tab=readme-ov-file#two-paths) that you can either use the CLI locally or go through the docker build instead. However, the docker image just hosts a webpage that redirects you to the websocket.

Further, if you follow the [quick start guide](https://github.com/jgarzik/brainpro?tab=readme-ov-file#two-paths) or the [Userguide](https://github.com/jgarzik/brainpro/blob/main/USERGUIDE.md#installation) and do `cargo build --release` followed by `yo` you will get:
> bash: yo: command not found

Overall, the documentation should be more clear about how to actually use this project, and what the specific requirements are. Also, it should be possible to use the CLI inside a docker container for security reasons, and the docker instructions should include the steps necessary to achieve that.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.