Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rya-sge committed Mar 27, 2024
1 parent 93834f9 commit bc34d49
Show file tree
Hide file tree
Showing 20 changed files with 524 additions and 589 deletions.
72 changes: 71 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,72 @@
# debtPayment
# IncomeVault
Contracts to perform coupon payment

## Initialization

You must first initialize the submodules, with

```
forge install
```

See also the command's [documentation](https://book.getfoundry.sh/reference/forge/forge-install).

Later you can update all the submodules with:

```
forge update
```

See also the command's [documentation](https://book.getfoundry.sh/reference/forge/forge-update).



## Compilation

The official documentation is available in the Foundry [website](https://book.getfoundry.sh/reference/forge/build-commands)

```
forge build --contracts src/RuleEngine.sol
```

```
forge build --contracts src/RuleWhiteList.sol
```

## Testing

You can run the tests with

```
forge test
```

To run a specific test, use

```
forge test --match-contract <contract name> --match-test <function name>
```

See also the test framework's [official documentation](https://book.getfoundry.sh/forge/tests), and that of the [test commands](https://book.getfoundry.sh/reference/forge/test-commands).

### Coverage

* Perform a code coverage

```
forge coverage --ffi
```

* Generate LCOV report

```
forge coverage --report lcov
```

- Generate `index.html`

```bash
forge coverage --report lcov && genhtml lcov.info --branch-coverage --output-dir coverage
```

See [Solidity Coverage in VS Code with Foundry](https://mirror.xyz/devanon.eth/RrDvKPnlD-pmpuW7hQeR5wWdVjklrpOgPCOA-PJkWFU) & [Foundry forge coverage](https://www.rareskills.io/post/foundry-forge-coverage)
Binary file removed classDiagram.png
Binary file not shown.
133 changes: 0 additions & 133 deletions classDiagram.svg

This file was deleted.

4 changes: 4 additions & 0 deletions doc/TOOLCHAIN.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ Warning:

## Generate documentation

### Coverage



### [docgen](https://github.com/OpenZeppelin/solidity-docgen)

>Solidity-docgen is a program that extracts documentation for a Solidity project.
Expand Down
Loading

0 comments on commit bc34d49

Please sign in to comment.