Skip to content

Commit

Permalink
update readme.md (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
killroy192 authored Mar 12, 2024
1 parent 1331ba9 commit 2b531d7
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 14 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Template to bootstrap solidity project

## Features

- Foundry for unit testing
- Hardhat for integration tests & deployment
- hardhat-sol-bundler for declarative and smart deployments
- [Foundry]((https://book.getfoundry.sh/)) for unit testing
- [Hardhat](https://hardhat.org/docs) for JS integration tests & deployment
- [hardhat-sol-bundler](https://github.com/dgma/hardhat-sol-bundler) for declarative deployments and upgrades
- linters, code formatter, pre-commit and pre-push hooks
- Makefile & Docker dev container for convenient and safe development
- Custom github action and quality gate workflow for fast CI strategy implementation
- Custom github action and quality gate workflow for flexible CI strategy implementation

## Requirements

Expand All @@ -23,10 +23,19 @@ Template to bootstrap solidity project
- Optional. [Docker](https://www.docker.com/)
- You'll need to run docker if you want to use dev container and safely play with smartcontracts & scripts

_note:_ For windows os you'll need to install `make`. For instance via choco: `sh choco install make`

## Installation

```sh
make
```

## Configuration

- All commands/aliases are declared in the Makefile.
- use forge as solidity formatter in your IDE settings
For VS it's recommended to use [Juan Blanco Plugin](https://github.com/juanfranblanco/vscode-solidity) and have the next sittings.json
- For VS it's recommended to use [Juan Blanco Plugin](https://github.com/juanfranblanco/vscode-solidity) and have the next sittings.json

```json
{
Expand All @@ -50,13 +59,9 @@ Template to bootstrap solidity project

Contributions are always welcome! Open a PR or an issue!

Please install the following:

And you probably already have `make` installed... but if not [try looking here.](https://askubuntu.com/questions/161104/how-do-i-install-make)

## Resources

- [Foundry Documentation](https://book.getfoundry.sh/)
- [Hardhat Documentation](https://hardhat.org/docs)
- [hardhat-sol-bundler Documentation](https://github.com/dgma/hardhat-sol-bundler)
```
- [Makefile simple guide](https://opensource.com/article/18/8/what-how-makefile)
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "sol-starter",
"version": "0.0.4",
"version": "0.0.1",
"description": "Template to bootstrap solidity project with foundry and hardhat",
"author": "Dogma Labs",
"author": "Dzmitry Lahunouski",
"license": "MIT",
"repository": {
"type": "git",
Expand Down

0 comments on commit 2b531d7

Please sign in to comment.