diff --git a/docs/community.md b/docs/community.md index d83caf94db..9ffd1553af 100644 --- a/docs/community.md +++ b/docs/community.md @@ -1,4 +1,4 @@ -Support chat +Community ======================= 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 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. +main contributors directly on Gitter or Twitter. diff --git a/docs/compile_tab.md b/docs/compile_tab.md index e625e911a8..55b7452da9 100644 --- a/docs/compile_tab.md +++ b/docs/compile_tab.md @@ -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. At each compilation, the static analysis tab builds a report. It is very 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)) diff --git a/docs/file_explorer.md b/docs/file_explorer.md index 50bf145fc0..e85cc2d484 100644 --- a/docs/file_explorer.md +++ b/docs/file_explorer.md @@ -34,7 +34,7 @@ Publish to 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. -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 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 -------------------- 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)). diff --git a/docs/index.md b/docs/index.md index f7b9a743e5..afd07c5dc7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. +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: .. toctree:: diff --git a/docs/quickstart_javascript_vm.md b/docs/quickstart_javascript_vm.md index d9fdc356f2..a9abe8ee1f 100644 --- a/docs/quickstart_javascript_vm.md +++ b/docs/quickstart_javascript_vm.md @@ -25,6 +25,7 @@ should have 100 ether. Sample contract --------------- + ``` {.sourceCode .none} pragma solidity ^0.4.16; diff --git a/docs/settings_tab.md b/docs/settings_tab.md index 83fccb854b..328b9da44f 100644 --- a/docs/settings_tab.md +++ b/docs/settings_tab.md @@ -1,17 +1,12 @@ Settings ======== -This section displays the current compiler version and allows one to -change to another version. +This section displays the current compiler version and allows one to change to another version. ![image](images/remix_settingstab.png) -Settings, available here: +Another important settings: -> - Text wrap: controls if the text in the editor should be wrapped. -> -> - 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. +- Text wrap: controls if the text in the editor should be wrapped. + +- 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. diff --git a/docs/tutorial_connect_remix_with_your_filesystem.md b/docs/tutorial_connect_remix_with_your_filesystem.md index 7c27f208be..1acdc88923 100644 --- a/docs/tutorial_connect_remix_with_your_filesystem.md +++ b/docs/tutorial_connect_remix_with_your_filesystem.md @@ -1,10 +1,10 @@ -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. -The code of Remixd can be checked out +The code of RemixD can be checked out [here](https://github.com/ethereum/remixd) . Remixd can be globally installed using the following command: @@ -21,8 +21,8 @@ folder. **Warning!** -`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.` +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. From `Remix IDE`, you will need to activate the connection. diff --git a/docs/udapp.md b/docs/udapp.md index 1ef2261153..642c0e2012 100644 --- a/docs/udapp.md +++ b/docs/udapp.md @@ -5,22 +5,20 @@ This section in the Run tab contains a list of deployed contracts to interact wi Several cases apply: - - The called function is declared as `constant` or `pure` in - 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 - value of the function. +- The called function is declared as `constant` or `pure` in 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 +value of the function. - - The called function has no special keywords. The action has a - light red background, clicking on does create a new transaction. - But this transaction cannot accept any amount of Ether. +- The called function has no special keywords. The action has a +light red background, clicking on does create a new transaction. +But this transaction cannot accept any amount of Ether. - - The called function is declared as `payable` in Solidity. The - action has a red background, clicking it does create a new - transaction and this transaction can accept value. +- The called function is declared as `payable` in Solidity. The +action has a red background, clicking it does create a new +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) . diff --git a/docs/workshop_Building_smart_contracts_with_Remix.md b/docs/workshop_Building_smart_contracts_with_Remix.md index bbcd50af7a..25ab50d5fb 100644 --- a/docs/workshop_Building_smart_contracts_with_Remix.md +++ b/docs/workshop_Building_smart_contracts_with_Remix.md @@ -5,4 +5,4 @@ We prepared a thorough workshop that will help you build your own DApp. We will ### 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.