feat: change readme

AElfProject · Apr 19, 2023 · 27dd871 · 27dd871
1 parent 41e2ede
commit 27dd871
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 7 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -92,7 +92,6 @@ fabric.properties
 
 # Editor-based Rest Client
 .idea/httpRequests
-.vscode
 
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
@@ -220,9 +219,8 @@ typings/
 
 ### VisualStudioCode template
 .vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
 
-**.node-xmlhttprequest-*
+**.node-xmlhttprequest-*
+
+# macOS DS_Store files
+.DS_Store
diff --git a/README.md b/README.md
@@ -776,7 +776,32 @@ AElf.version; // eg. 3.2.23
 ![browsers](https://img.shields.io/badge/browsers-latest%202%20versions-brightgreen.svg)
 ![node](https://img.shields.io/badge/node->=10-green.svg)
 
-## 4. About contributing
+## 4. Building
+-   [Node.js](https://nodejs.org)
+-   [npm](https://www.npmjs.com/)
+
+```bash
+sudo apt-get update
+sudo apt-get install nodejs
+sudo apt-get install npm
+```
+
+### 4.1 Building (webpack)
+
+Build the web3.js package:
+
+```bash
+yarn run build
+```
+
+### 4.2 Testing (jest)
+
+```bash
+yarn run test
+```
+
+Commit code will run test and lint automatically, and show the test result in readme.md, please make sure all test cases passed.
+### 4.3 About contributing
 
 Read out [contributing guide](./.github/CONTRIBUTING.md)