From 4acf4a61a8f4d547d63cbcea8de719a0c5e54afe Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Wed, 22 Aug 2018 16:15:12 -0400 Subject: [PATCH 1/2] docs: Edit modules list, add README and lint to analyzer --- README.md | 8 ++++++-- remix-analyzer/README.md | 26 ++++++++++++++++++++++++++ remix-analyzer/package.json | 3 ++- 3 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 remix-analyzer/README.md diff --git a/README.md b/README.md index a111891b1f..71dd4f082f 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,15 @@ The debugger itself contains several controls that allow stepping over the trace ## 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 diff --git a/remix-analyzer/README.md b/remix-analyzer/README.md new file mode 100644 index 0000000000..079f33f240 --- /dev/null +++ b/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 + diff --git a/remix-analyzer/package.json b/remix-analyzer/package.json index 4fac8fcfa7..81bf6a42f7 100644 --- a/remix-analyzer/package.json +++ b/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": [ From 4b0678504d08c0dd178fbc59580378c019429476 Mon Sep 17 00:00:00 2001 From: yann300 Date: Mon, 24 Sep 2018 14:52:01 +0200 Subject: [PATCH 2/2] Update package.json --- remix-analyzer/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/remix-analyzer/package.json b/remix-analyzer/package.json index 81bf6a42f7..2a24abc649 100644 --- a/remix-analyzer/package.json +++ b/remix-analyzer/package.json @@ -28,7 +28,7 @@ }, "scripts": { "lint": "standard", - "test": "lint && tape ./test/tests.js" + "test": "npm run lint && tape ./test/tests.js" }, "standard": { "ignore": [