mirror
/
remix-project
mirror of https://github.com/ethereum/remix-project.git
2
0
Fork 0
Code Issues Releases Wiki Activity

docs: General grammar and stylistic edits

Browse Source 
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.
pull/7/head
Richard Littauer 6 years ago
parent c7d02259ee
commit ee1b159ef5
7 changed files with 18 additions and 19 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 6
      CONTRIBUTING.md
  2. 7
      docs/code_contribution_guide.md
  3. 6
      docs/community.md
  4. 0
      docs/index.md
  5. 12
      docs/index.rst
  6. 2
      docs/packages.md
  7. 4
      docs/support.md

6
CONTRIBUTING.md
Unescape View File

@ -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)! 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`. 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: 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. 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.

7
docs/code_contribution_guide.md
Unescape View File

@ -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 You can do that by opening issues, giving feedback or by contributing a pull request
to our codebase. to our codebase.
Remix application is built with Javascript and it doesn't use any framework, we only 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 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.
package.json file 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).

6
docs/community.md
Unescape View File

@ -3,12 +3,12 @@ Community
We know that blockchain ecosystem is very new and that lots of information is scattered around the web. 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 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, 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 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 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 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.

0
docs/index.md
Unescape View File

12
docs/index.rst
Unescape View File

@ -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. 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. Remix also supports testing, debugging and deploying of smart contracts and much more.
Our Remix project with all its features is available Our Remix project with all its features is available
at `remix.ethereum.org <http://remix.ethereum.org>`__ and more information can be found in these at `remix.ethereum.org <http://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
<https://github.com/ethereum/remix-ide>`__. <https://github.com/ethereum/remix-ide>`__.
This set of documents covers instructions on how to use Remix and some tutorials to help you get started. 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 <https://solidity.readthedocs.io>`__ - `Solidity documentation <https://solidity.readthedocs.io>`__
- `Remix alpha <http://remix-alpha.ethereum.org>`__ - version where we test new Remix release (not stable!) - `Remix alpha <http://remix-alpha.ethereum.org>`__ - The version where we test new Remix release (not stable!).
- `Ethereum Stackexchange for Remix <https://ethereum.stackexchange.com/questions/tagged/remix>`__ - `Ethereum StackExchange for Remix <https://ethereum.stackexchange.com/questions/tagged/remix>`__
- `Community support channel <https://gitter.im/ethereum/remix>`__ - `Community support channel <https://gitter.im/ethereum/remix>`__
- `Dapp Developer resources (Ethereum wiki) <https://github.com/ethereum/wiki/wiki/Dapp-Developer-Resources>`__ - `Ðapp Developer resources (Ethereum wiki) <https://github.com/ethereum/wiki/wiki/Dapp-Developer-Resources>`__
.. toctree:: .. toctree::

2
docs/packages.md
Unescape View File

@ -1,7 +1,7 @@
Packages 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? 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. - 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.

4
docs/support.md
Unescape View File

@ -3,7 +3,7 @@ Support chat
We know that blockchain ecosystem is very new and that lots of information is scattered around the web. 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 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, 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.

Write Preview
Loading…
Cancel
Save