docs: more context on boa usage and examples - Githubissues

vyperlang / titanoboa

a vyper interpreter

https://titanoboa.readthedocs.io

Other

242 stars 41 forks source link

docs: more context on boa usage and examples #181

Closed AlbertoCentonze closed 3 months ago

AlbertoCentonze commented 5 months ago

What I did

Improved documentation

How I did it

Adding the following sections:

[x] introduction explaining why the need for this framework + integrate what is already in the readme
[x] install instructions (pip, poetry...), how to use the latest version from git.

Minor mentions added

[x] native import syntax
[x] coverage doesn't work in fast mode
[x] fast mode
[x] jupyter notebook magic stuff

Structural changes:

[x] merge the coverage section in the testing one (the two are short and related).

Description for the changelog

docs: more context on boa usage and examples

Cute Animal Picture