docs: update readme

emindeniz99 · Jan 18, 2022 · bcec748 · bcec748 · vercel · Jan 18, 2022
1 parent 8afd0e1
commit bcec748
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/Readme.md b/Readme.md
@@ -1,15 +1,21 @@
 
+## Screenshot
+
+![screenshot](./screenshot.jpeg)
+
 ## WORKING DIAGRAM OF THE CONTRACTS
-![Tux, the Linux mascot](diagram_of_contracts.png)
+![diagram_of_contracts](diagram_of_contracts.png)
 
 ## Docs
-Please look at the pdf file
+Please look at the reports
+* [cmpe483_assignment_1_report.pdf](./cmpe483_assignment_1_report.pdf)
+* [CMPE_483_ASSIGNMENT_2_REPORT.pdf](./CMPE_483_ASSIGNMENT_2_REPORT.pdf)
 
-## Testing
+## Scripts
 * `yarn` to install dependencies(package.json)
-* `yarn truffle test` to start test
-* `yarn truffle compile` to compile contracts to abi json
+* `yarn contracts:compile` to compile contracts to abi json (truffle)
+* `yarn fe:build` to build frontend (next.js)
+* `yarn fe:dev` to compile contracts to abi json and start frontend development server
 
 ## Resources
 * https://www.dappuniversity.com/articles/how-to-build-a-blockchain-app
-* 
diff --git a/screenshot.jpeg b/screenshot.jpeg
diff --git a/truffle/Readme.md b/truffle/Readme.md
@@ -0,0 +1,14 @@
+
+## WORKING DIAGRAM OF THE CONTRACTS
+![diagram_of_contracts.png](./../diagram_of_contracts.png)
+
+## Docs
+Please look at the pdf file
+
+## Testing
+* `yarn` to install dependencies(package.json)
+* `yarn truffle test` to start test
+* `yarn truffle compile` to compile contracts to abi json
+
+## Resources
+* https://www.dappuniversity.com/articles/how-to-build-a-blockchain-app