Summarise the tools in the README

Question

Summarise the tools in the README

Opened this issue 8 years ago · 3 comments

Right now, I have no idea if any of these tools could be useful to me because the README file links me to a redirect back to github and there's no docs/ dir or anything like that. Even just a quick summary of what tools are offered and their general use would be very handy.

Answer 1 · 2017-08-11T19:16:50.000Z

Yes please… Just came across a recommendation to install the tools, but I have no idea what tools there are!

I did find that if you switch to the wiki branch that there's some more info.

Answer 2 · 2017-08-12T05:12:54.000Z

This code ported from code.google.com years ago, but the docs never made it over. They might still be kicking around somewhere. Let me see if I can dig them up.

Answer 3 · 2017-08-12T05:17:43.000Z

https://github.com/google/crush-tools/blob/wiki/CrushTutorial.md

https://github.com/google/crush-tools/blob/wiki/CrushAppBasics.md

https://github.com/google/crush-tools/blob/wiki/CheckingForErrors.md

There are other docs + tool docs in the wiki as well. Check that until someone can get these ported.

Thanks!