Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zone117x committed Sep 30, 2018
1 parent a6fda3d commit 433f940
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,52 +12,49 @@

# Meadow

An Ethereum implementation geared towards Solidity testing and development. Written completely in cross-platform C# with .NET Core. Use may use Meadow in VSCode, Visual Studio, and JetBrains Rider.
An integrated Ethereum implementation and tool suite focused on Solidity testing and development. Written completely in cross-platform C# with .NET Core. Meadow can be used in VSCode, Visual Studio, and JetBrains Rider.

## Quick start / guides

#### Powerful Solidity contract development, deployment, and interaction
* [Writing unit tests](TODO) - getting started writing tests against Solidity contracts and generating code coverage reports.

<img src="/images/screenshot1.png?raw=true" width="700" />
* [Using the CLI](src/Meadow.Cli/README.md) - contract deployment and interaction against testnode or production.

Provides an intuitive framework for writing C# tests against contract deployments and interactions. Includes a personal Ethereum test node that automatically is setup during test executions.
* [VSCode Solidity Debugger](TODO)

---

#### Visibility into Solidity revert / exception call stacks
#### Powerful Solidity contract development, deployment, and interaction

<img src="/images/screenshot2.png?raw=true" width="700" />
<img src="/images/screenshot1.png?raw=true" width="700" />

Provides an intuitive framework for writing C# to perform contract deployments, transactions, function calls, RPC requests, and more. Solidity source files are automatically compiled and exposed as C# classes with all contract methods, events, and natspec documentation. Includes a personal Ethereum test node that automatically is setup during test executions.

---

#### Solidity debugging with breakpoints, stepping, rewinding, variable inspection, et cetera
#### Visibility into Solidity revert / exception call stacks

<img src="/images/screenshot3.png?raw=true" width="800" />
<img src="/images/screenshot2.png?raw=true" width="700" />

See [Solidity Debugger](#solidity-debugger).
Better understanding and investigation of Solidity execution problems.

---

#### Solidity unit test code coverage HTML reports

<img src="/images/screenshot4.png?raw=true" width="600" />

---

## Quick start / guides

* [Writing unit tests](TODO) - getting started writing tests against Solidity contracts and generating code coverage reports.

* [Using the CLI](src/Meadow.Cli/README.md) - contract deployment and interaction against testnode or production.

* [VSCode Solidity Debugger](TODO)
Perform thorough testing of Solidity codebases. See .sol source code coverage for line, branch, and function execution.

---

# Solidity Debugger

[![vs marketplace](https://img.shields.io/vscode-marketplace/v/hosho.solidity-debugger.svg)](https://marketplace.visualstudio.com/items?itemName=hosho.solidity-debugger)

Solidity debugger extension for VSCode supporting beakpoints, stepping, rewinding, call stacks, local & state variable inspection.
<img src="/images/screenshot3.png?raw=true" width="800" />

Solidity debugger extension for Visual Studio Code supporting beakpoints, stepping, rewinding, call stacks, local & state variable inspection.

---

Expand Down

0 comments on commit 433f940

Please sign in to comment.