Skip to content

Commit 44d5a27

Browse files
authored
Update README.md
1 parent ce3532b commit 44d5a27

File tree

1 file changed

+2
-45
lines changed

1 file changed

+2
-45
lines changed

README.md

+2-45
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,3 @@
1-
# Forge Template
1+
# xTRIBE
22

3-
A template for quickly getting started with forge
4-
5-
## Getting Started
6-
7-
```
8-
mkdir my-project
9-
cd my-project
10-
forge init --template https://github.com/FrankieIsLost/forge-template
11-
git submodule update --init --recursive ## initialize submodule dependencies
12-
npm install ## install development dependencies
13-
forge build
14-
forge test
15-
```
16-
17-
## Features
18-
19-
### Testing Utilities
20-
21-
Includes a `Utilities.sol` contract with common testing methods (like creating users with an initial balance), as well as various other utility contracts.
22-
23-
### Preinstalled dependencies
24-
25-
`ds-test` for testing, `forge-std` for better cheatcode UX, and `solmate` for optimized contract implementations.
26-
27-
### Linting
28-
29-
Pre-configured `solhint` and `prettier-plugin-solidity`. Can be run by
30-
31-
```
32-
npm run solhint
33-
npm run prettier
34-
```
35-
36-
### CI with Github Actions
37-
38-
Automatically run linting and tests on pull requests.
39-
40-
### Default Configuration
41-
42-
Including `.gitignore`, `.vscode`, `remappings.txt`
43-
44-
## Acknowledgement
45-
46-
Inspired by great dapptools templates like https://github.com/gakonst/forge-template, https://github.com/gakonst/dapptools-template and https://github.com/transmissions11/dapptools-template
3+
https://tribe.fei.money/t/xtribe-tokenomics-upgrade/4038

0 commit comments

Comments
 (0)