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

Prepare detailed documentation / wiki for public release #16

Open
zyzek opened this issue Dec 11, 2017 · 0 comments
Open

Prepare detailed documentation / wiki for public release #16

zyzek opened this issue Dec 11, 2017 · 0 comments

Comments

@zyzek
Copy link
Contributor

zyzek commented Dec 11, 2017

We need to review all our documentation (including auto-generated), and possibly centralise it on the GitHub wiki rather than the various .md files we currently have scattered around. Some of these may also be out of date, so we need to check this too.

  • Public release docs should provide how-tos / examples for:
    • Disassembly
    • Decompilation
    • Analysis with Souffle (both a basic example with one contract, and also for a batch of contracts using the bulk_analyser)
  • Check, proof and edit function extraction and memory abstraction Wiki pages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant