From a200799e38ff7589c9a9258651ec4d234f43ebdd Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 23 Aug 2018 10:26:28 -0400 Subject: [PATCH 1/2] docs: General grammar and stylistic edits This should make the docs a bit more readable. A more detailed overhaul is needed on some of these, but this is a good first step. --- CONTRIBUTING.md | 6 +++--- docs/code_contribution_guide.md | 7 +++---- docs/community.md | 6 +++--- docs/index.md | 0 docs/index.rst | 12 ++++++------ docs/packages.md | 2 +- docs/support.md | 4 ++-- 7 files changed, 18 insertions(+), 19 deletions(-) delete mode 100644 docs/index.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae1309a1dd..424c4d55db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,13 +3,13 @@ Everyone is very welcome to contribute on the codebase of Remix. Please reach us in [Gitter](https://gitter.im/ethereum/remix)! The easiest way to work on `remix-debugger` or `remix-solidity` is to pull the `remix-ide` (Remix IDE) repository (https://github.com/ethereum/remix-ide) which has a strong Remix integration. Then, in `remix-ide`, execute `npm install`, `npm run pullremix`, `npm run linkremixsolidity`. -then `npm run build && npm run serve` to start a new Remix IDE instance (you can browse `127.0.0.1:8080`). +then `npm run build && npm run serve` to start a new Remix IDE instance (you can see it in the browser at `127.0.0.1:8080`). To interact with the Remix code: -1. For static analysis: compile a new contact, click on the `Analysis`, the content of this tab is provided by the `remix-solidity/analysis` library +1. For static analysis: compile a new contact, click on the `Analysis`. The content of this tab is provided by the `remix-solidity/analysis` library. -2. For Debugging: compile a new contact, deploy it (`Create` button in the `run` tab), in the remix IDE terminal a transaction should appear, click on `Debug`. The Debugger tab get the focus, the content if this tab is provided by the `remix-debugger` library. +2. For Debugging: compile a new contact, deploy it (`Create` button in the `run` tab), and then in the remix IDE terminal a transaction should appear, click on `Debug`. The Debugger tab get the focus, the content if this tab is provided by the `remix-debugger` library. 3. For Decoding local and state variables: follow 2), then expand (is not already) the `Solidity State` and `Solidity Locals` panels, the content of thoses panel are provided by the `remix-solidity/decoder` library. diff --git a/docs/code_contribution_guide.md b/docs/code_contribution_guide.md index ad647df40e..3ff6334308 100644 --- a/docs/code_contribution_guide.md +++ b/docs/code_contribution_guide.md @@ -5,8 +5,7 @@ Remix is an open source tool and we encourage anyone to help us improve our tool You can do that by opening issues, giving feedback or by contributing a pull request to our codebase. -Remix application is built with Javascript and it doesn't use any framework, we only -rely on selected set of NPM modules, like `yo-yo`, `csjs-inject` and others. Check out -package.json file to learn more about the stack. +The Remix application is built with JavaScript and it doesn't use any framework. We only +rely on selected set of npm modules, like `yo-yo`, `csjs-inject` and others. Check out the `package.json` files in the Remix submodules to learn more about the stack. -To learn more, please visit our [Github page](https://github.com/ethereum/remix-ide). +To learn more, please visit our [GitHub page](https://github.com/ethereum/remix-ide). diff --git a/docs/community.md b/docs/community.md index 9ffd1553af..a76c8fd09d 100644 --- a/docs/community.md +++ b/docs/community.md @@ -3,12 +3,12 @@ Community We know that blockchain ecosystem is very new and that lots of information is scattered around the web. That is why we created a community support channel where we and other users try to answer your questions if -you get stuck using Remix. Please, join [the community](https://gitter.im/ethereum/remix) and ask community for help. +you get stuck using Remix. Please, join [the community](https://gitter.im/ethereum/remix) and ask for help. For anyone who is interested in developing a custom plugin for Remix or who wants to contribute to the codebase, -we opened [contributors' channel](https://gitter.im/ethereum/remix-dev) specially for developers working on Remix tool. +we opened a [contributors' channel](https://gitter.im/ethereum/remix-dev) especially for developers working on Remix tools. We would kindly ask you to respect the space and to use it for getting help with your work and the developers' channel for discussions related to working on Remix codebase. If you have ideas for collaborations or you want to promote your project, try to find some more appropriate channels to do so. Or you can contact -main contributors directly on Gitter or Twitter. +the main contributors directly on Gitter or Twitter. diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/index.rst b/docs/index.rst index 55f7be4119..b3e2c1a356 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,28 +2,28 @@ Welcome to Remix documentation! =============================== Remix is a powerful, open source tool that helps you write Solidity contracts straight from the browser. -Written in Javascript, Remix supports both usage in the browser or locally. +Written in JavaScript, Remix supports both usage in the browser and locally. Remix also supports testing, debugging and deploying of smart contracts and much more. Our Remix project with all its features is available at `remix.ethereum.org `__ and more information can be found in these -docs. Our tool is available at `our GitHub repository +docs. Our IDE tool is available at `our GitHub repository `__. This set of documents covers instructions on how to use Remix and some tutorials to help you get started. -Userful links: +Useful links: - `Solidity documentation `__ -- `Remix alpha `__ - version where we test new Remix release (not stable!) +- `Remix alpha `__ - The version where we test new Remix release (not stable!). -- `Ethereum Stackexchange for Remix `__ +- `Ethereum StackExchange for Remix `__ - `Community support channel `__ -- `Dapp Developer resources (Ethereum wiki) `__ +- `Ðapp Developer resources (Ethereum wiki) `__ .. toctree:: diff --git a/docs/packages.md b/docs/packages.md index ba8440c424..c606a8028b 100644 --- a/docs/packages.md +++ b/docs/packages.md @@ -1,7 +1,7 @@ Packages ======== -This part focuses on using `Remix IDE`, which is a browser based smart contract IDE. We will basically answer to the question: +This part focuses on using `Remix IDE`, which is a browser based smart contract IDE. We will basically answer the question: Where can I use / download `Remix IDE`, and what is the difference between packages? - An online version is available at [https://remix.ethereum.org](https://remix.ethereum.org). This version is stable and is updated at almost every release. diff --git a/docs/support.md b/docs/support.md index 6bdd96968a..85dfb873c5 100644 --- a/docs/support.md +++ b/docs/support.md @@ -3,7 +3,7 @@ Support chat We know that blockchain ecosystem is very new and that lots of information is scattered around the web. That is why we created a community support chat where we and other users try to answer your questions if -you get stuck using Remix. Please, join [the Remix channel](https://gitter.im/ethereum/remix) and ask community for help. +you get stuck using Remix. Please, join [the Remix channel](https://gitter.im/ethereum/remix) and ask the community for help. For anyone who is interested in developing a custom plugin for Remix or who wants to contribute to the codebase, -we opened [another channel](https://gitter.im/ethereum/remix-dev) specially for developers working on Remix tool. +we've opened [another channel](https://gitter.im/ethereum/remix-dev) specially for developers working on Remix tool. From e1c599b8406baaccdb88daa96c1b877a6bd8cd25 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 20 Sep 2018 09:45:56 -0400 Subject: [PATCH 2/2] docs: Add Contributors to license --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 853b46db12..30fbb3489e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016 +Copyright (c) 2016-2018 Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal