From 27dd871353a71e2766606e52315b5a716b87724c Mon Sep 17 00:00:00 2001 From: AbigailDeng Date: Wed, 19 Apr 2023 15:59:16 +0800 Subject: [PATCH] feat: change readme --- .DS_Store | Bin 6148 -> 0 bytes .gitignore | 10 ++++------ README.md | 27 ++++++++++++++++++++++++++- 3 files changed, 30 insertions(+), 7 deletions(-) delete mode 100644 .DS_Store diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 5008ddfcf53c02e82d7eee2e57c38e5672ef89f6..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeH~Jr2S!425mzP>H1@V-^m;4Wg<&0T*E43hX&L&p$$qDprKhvt+--jT7}7np#A3 zem<@ulZcFPQ@L2!n>{z**++&mCkOWA81W14cNZlEfg7;MkzE(HCqgga^y>{tEnwC%0;vJ&^%eQ zLs35+`xjp>T0=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)