mirror of
https://github.com/pezkuwichain/revive.git
synced 2026-06-15 04:31:08 +00:00
The revive compiler documentation (#424)
This PR adds comprehensive project documentation in the form of an mdBook. --------- Signed-off-by: xermicus <cyrill@parity.io> Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com> Co-authored-by: LJ <81748770+elle-j@users.noreply.github.com> Co-authored-by: PG Herveou <pgherveou@gmail.com>
This commit is contained in:
@@ -0,0 +1,16 @@
|
||||
# Welcome
|
||||
|
||||
Hello and a warm welcome to the `revive` Solidity compiler book!
|
||||
|
||||
## Target audience
|
||||
|
||||
- **Solidity dApp developers** should read the [user guide](./user_guide.md). Solidity on PolkaVM introduces important differences to EVM which should be well understood.
|
||||
- **Contributors** will find the [developer guide](./developer_guide.md) helpful for getting up to speed.
|
||||
|
||||
## Other Polkadot contracts resources
|
||||
|
||||
Head to [contracts.polkadot.io](https://docs.polkadot.com/develop/smart-contracts/) for more general information about contracts on Polkadot.
|
||||
|
||||
## About
|
||||
|
||||
This [mdBook](https://github.com/rust-lang/mdBook) documents the revive Solidity compiler project. The content is found under `book/`. Run `make book` to observe changes.
|
||||
Reference in New Issue
Block a user