Browse Source

docs: Edit modules list, add README and lint to analyzer

pull/13/head
Richard Littauer 4 years ago
parent
commit
cfb8a77a56
  1. 8
      README.md
  2. 26
      remix-analyzer/README.md
  3. 3
      remix-analyzer/package.json

8
README.md

@ -40,11 +40,15 @@ The debugger itself contains several controls that allow stepping over the trace
## <a name="modules"></a>Remix Modules
Remix is built out of 3 different modules:
Remix is built out of several different modules:
+ [`remix-analyzer`](remix-analyzer/README.md)
+ [`remix-solidity`](remix-solidity/README.md) provides Solidity analysis and decoding functions.
+ [`remix-lib`](remix-lib/README.md)
+ [`remix-debug`](remix-debugger/README.md) contains the debugger.
+ [`remix-debug`](remix-debugger/README.md) is now *deprecated*. It contains the debugger.
+ [`remix-tests`](remix-tests/README.md) contains our tests.
Each generally has their own npm package and test suite, as well as basic documentation.
## Contributing

26
remix-analyzer/README.md

@ -0,0 +1,26 @@
# Remix Analyzer
## Install
```sh
npm i remix-analyzer
```
## Contribute
We need some better documentation. Besides that, we are always open to new features or bug reports. Open an issue or a pull request.
### Tests
Make sure that you add test cases.
```sh
npm run test
```
The code style should conform to standard; make sure to your lint your code before submitting a PR.
## License
MIT (c) 2018 Remix Team

3
remix-analyzer/package.json

@ -27,7 +27,8 @@
"tape": "^4.6.0"
},
"scripts": {
"test": "standard && tape ./test/tests.js"
"lint": "standard",
"test": "lint && tape ./test/tests.js"
},
"standard": {
"ignore": [

Loading…
Cancel
Save