Skip to content
This repository has been archived by the owner on Aug 22, 2024. It is now read-only.

suggestion: add example + usage in the README #1226

Open
mimoo opened this issue Jul 19, 2023 · 1 comment
Open

suggestion: add example + usage in the README #1226

mimoo opened this issue Jul 19, 2023 · 1 comment

Comments

@mimoo
Copy link

mimoo commented Jul 19, 2023

Just a suggestion, but it's good practice to add a very short example in the README so people can have an idea of what it looks like. It also should be straight forward how to install + use the tool. Right now I found https://github.com/facebookexperimental/MIRAI/blob/main/documentation/InstallationGuide.md on how to install, but I'm still searching for how to run MIRAI itself

EDIT: ended up finding it here https://github.com/facebookexperimental/MIRAI/blob/main/documentation/Overview.md#how-to-use-mirai (suggestion here would be to have a "usage" section as it's quite common, and use codeblocks for the commands as they stand out)

@hermanventer
Copy link
Contributor

I'd be happy to review and approve a PR that does makes the README look exactly how you expect it to look. :-)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants