Skip to content

Commit 13c80cd

Browse files
committed
Add getting started and troubleshooting sections to README.md
1 parent e68f8e1 commit 13c80cd

1 file changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,30 @@ $ forge script script/DeployProxy.s.sol:UpgradeProxyScript --rpc-url $RPC_URL --
218218
- [Solidity Documentation](https://docs.soliditylang.org/en/v0.8.19/)
219219
- [ConsenSys Best Practices for Smart Contract Systems](https://consensys.github.io/smart-contract-best-practices/)
220220

221+
222+
## Getting Started
223+
224+
```bash
225+
# Install
226+
git clone https://github.com/oumaoumag/ProxyContractImplementation.git
227+
cd proxy-contract-implementation
228+
forge install
229+
230+
# Build and test
231+
forge build
232+
forge test -v
233+
```
234+
235+
## Troubleshooting
236+
237+
- **Compilation**: Use Solidity ^0.8.13, try `forge clean`
238+
- **Tests**: Run `foundryup` to update Foundry
239+
- **Deployment**: Check RPC endpoint and account balanc
240+
221241
## License
222242

223243
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
224244

225245
Copyright (c) 2025 Ouma Ouma
226246

227-
This implementation of the EIP-1967 proxy pattern is provided as an educational resource and may be freely used in your own projects according to the terms of the MIT License.
228-
247+
This implementation of the EIP-1967 proxy pattern is provided as an educational resource and may be freely used in your own projects according to the terms of the MIT License.

0 commit comments

Comments
 (0)