search

facebookexperimental / MIRAI

Rust mid-level IR Abstract Interpreter
MIT License
1k stars 86 forks source link

suggestion: add example + usage in the README #1226

Open mimoo opened 1 year ago

mimoo commented 1 year ago

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 commented 1 year ago

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