Commit db525f77 authored by ninabreznik's avatar ninabreznik

One more re-styling update

parent 2dbff857
Support chat 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.
...@@ -11,4 +11,4 @@ we opened [contributors' channel](https://gitter.im/ethereum/remix-dev) speciall ...@@ -11,4 +11,4 @@ we opened [contributors' channel](https://gitter.im/ethereum/remix-dev) speciall
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. main contributors directly on Gitter or Twitter.
...@@ -25,4 +25,4 @@ using the bzz URL located in the details modal dialog `SWARM LOCATION`. ...@@ -25,4 +25,4 @@ using the bzz URL located in the details modal dialog `SWARM LOCATION`.
Compilation Errors and Warning are displayed below the contract section. Compilation Errors and Warning are displayed below the contract section.
At each compilation, the static analysis tab builds a report. It is very At each compilation, the static analysis tab builds a report. It is very
valuable when addressing reported issues even if the compiler doesn't valuable when addressing reported issues even if the compiler doesn't
complain. (see ../analysis\_tab) complain. ([see more](http://remix.readthedocs.io/en/latest/analysis_tab.html))
...@@ -34,7 +34,7 @@ Publish to Gist ...@@ -34,7 +34,7 @@ Publish to Gist
Publishes all files from the browser folder to a gist. Publishes all files from the browser folder to a gist.
Gist API has changed in 2018 and it unfortunately requires users to be authenticated to be able to publish a gist. Gist API has changed in 2018 and it unfortunately requires users to be authenticated to be able to publish a gist.
Under https://github.com/settings/tokens select Generate new token. Click [this link](https://github.com/settings/tokens) to Github tokens setup and select Generate new token.
Then check only Create gists checkbox and generate a new token. Then check only Create gists checkbox and generate a new token.
Then paste it in Remix (right panel/Settings tab) and click Save. Now you should be able to use the feature. Then paste it in Remix (right panel/Settings tab) and click Save. Now you should be able to use the feature.
...@@ -49,4 +49,4 @@ Connect your filesystem to Remix ...@@ -49,4 +49,4 @@ Connect your filesystem to Remix
-------------------- --------------------
Allows to sync between Remix and your local file system (see Allows to sync between Remix and your local file system (see
[more about RemixD][http://remix.readthedocs.io/en/latest/tutorial_connect_remix_with_your_filesystem.html]). [more about RemixD](http://remix.readthedocs.io/en/latest/tutorial_connect_remix_with_your_filesystem.html)).
...@@ -13,6 +13,19 @@ documentation and the source code of the project is available at [our GitHub rep ...@@ -13,6 +13,19 @@ documentation and the source code of the project is available at [our GitHub rep
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:
- [Solidity documentation](https://solidity.readthedocs.io/)
- [Remix alpha](http://remix-alpha.ethereum.org/) - version where we test new Remix release (not stable!)
- [Ethereum Stackexchange for Remix](https://ethereum.stackexchange.com/questions/tagged/remix)
- [Community support channel](https://gitter.im/ethereum/remix)
- [Dapp Developer resources (Ethereum wiki)](https://github.com/ethereum/wiki/wiki/Dapp-Developer-Resources)
.. quick-start: .. quick-start:
.. toctree:: .. toctree::
......
...@@ -25,6 +25,7 @@ should have 100 ether. ...@@ -25,6 +25,7 @@ should have 100 ether.
Sample contract Sample contract
--------------- ---------------
``` {.sourceCode .none} ``` {.sourceCode .none}
pragma solidity ^0.4.16; pragma solidity ^0.4.16;
......
Settings Settings
======== ========
This section displays the current compiler version and allows one to This section displays the current compiler version and allows one to change to another version.
change to another version.
![image](images/remix_settingstab.png) ![image](images/remix_settingstab.png)
Settings, available here: Another important settings:
> - Text wrap: controls if the text in the editor should be wrapped. - Text wrap: controls if the text in the editor should be wrapped.
>
> - Enable optimization: defines if the compiler should enable - Enable optimization: defines if the compiler should enable optimization during compilation. Enabling this option saves execution gas. It is useful to enable optimization for contracts ready to be deployed in production but could lead to some inconsistencies when debugging such a contract.
> optimization during compilation. Enabling this option saves execution
> gas. It is useful to enable optimization for contracts ready to be
> deployed in production but could lead to some inconsistencies when
> debugging such a contract.
Access your local filesystem by using Remixd Access your local filesystem by using RemixD
=================================================== ===================================================
Remixd is an npm module. Its purpose is to give the remix web RemixD is an npm module. Its purpose is to give the remix web
application access to a folder from your local computer. application access to a folder from your local computer.
The code of Remixd can be checked out The code of RemixD can be checked out
[here](https://github.com/ethereum/remixd) . [here](https://github.com/ethereum/remixd) .
Remixd can be globally installed using the following command: Remixd can be globally installed using the following command:
...@@ -21,8 +21,8 @@ folder. ...@@ -21,8 +21,8 @@ folder.
**Warning!** **Warning!**
`Remixd provides full read and write access to the given folder for any RemixD provides `full read and write access` to the given folder for `any
application that can access the TCP port 65520 on your local host.` application` that can access the `TCP port 65520` on your local host.
From `Remix IDE`, you will need to activate the connection. From `Remix IDE`, you will need to activate the connection.
......
...@@ -5,22 +5,20 @@ This section in the Run tab contains a list of deployed contracts to interact wi ...@@ -5,22 +5,20 @@ This section in the Run tab contains a list of deployed contracts to interact wi
Several cases apply: Several cases apply:
- The called function is declared as `constant` or `pure` in - The called function is declared as `constant` or `pure` in Solidity. The action has a blue background, clicking it does not
Solidity. The action has a blue background, clicking it does not create a new transaction. Clicking it is not necessary because there are not state changes - but it will update the return
create a new transaction. Clicking it is not necessary because value of the function.
there are not state changes - but it will update the return
value of the function.
- The called function has no special keywords. The action has a - The called function has no special keywords. The action has a
light red background, clicking on does create a new transaction. light red background, clicking on does create a new transaction.
But this transaction cannot accept any amount of Ether. But this transaction cannot accept any amount of Ether.
- The called function is declared as `payable` in Solidity. The - The called function is declared as `payable` in Solidity. The
action has a red background, clicking it does create a new action has a red background, clicking it does create a new
transaction and this transaction can accept value. transaction and this transaction can accept value.
For more information about Solidity modifier, see [Solidity For more information see more about [Solidity
modifier](http://solidity.readthedocs.io/en/develop/miscellaneous.html?highlight=pure#modifiers) modifier](http://solidity.readthedocs.io/en/develop/miscellaneous.html?highlight=pure#modifiers)
. .
......
...@@ -5,4 +5,4 @@ We prepared a thorough workshop that will help you build your own DApp. We will ...@@ -5,4 +5,4 @@ We prepared a thorough workshop that will help you build your own DApp. We will
### Let's get started ### Let's get started
To start with the workshop, please click [this link](https://slides.com/ninabreznik/deck-11-13#/) This workshop was part of preparations for ethCC and Edcon. You can [watch the presentation talk](https://www.youtube.com/watch?v=nAI_Cr5Y8JY) and in parallel open the [workshop slides](https://slides.com/ninabreznik/deck-11-13#/) and follow along.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment