pre-commit, process-templates

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
         description: Generate docs with `forge doc`
         language: system
         # generates docs and unstages files if only the commit hash changed within the file, this way only when the documentation is updated, the documentation needs to be regenerated and only the changed files are pushed
-        entry: "script/util/doc_gen.sh"
+        entry: "scripts/util/doc_gen.sh"
         pass_filenames: false
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v3.0.3"

README.md

@@ -10,8 +10,13 @@ Ethereum smart contracts that power the [Matic Network](https://matic.network).
 npm install
 ```
 
-### Compile
+### Setup
 
+```
+pre-commit install
+```
+
+### Compile
 
 ```
 npm run template:process -- --bor-chain-id 15001
@@ -21,6 +26,7 @@ bor-chain-id should be:
 **local: 15001**  
 Mainnet = 137  
 TestnetV4 (Mumbai) = 80001
+
 ### Main chain and side chain
 
 - Main chain
@@ -48,18 +54,21 @@ npm run bor:clean
 ### Run tests
 
 Run Hardhat test
+
 ```
 npm test:hardhat
 ```
 
 Run Foundry test
+
 ```
 npm test:foundry
 ```
 
 ### Coverage
 
 Run coverage with
+
 ```
 npm run coverage
 ```