remix-project/docs/index.rst

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 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 <http://remix.ethereum.org>`__ and more information can be found in these
docs.  Our IDE tool is available at `our GitHub repository
<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.

Useful links:

- `Solidity documentation <https://solidity.readthedocs.io>`__

- `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>`__

- `Community support channel <https://gitter.im/ethereum/remix>`__

- `Ðapp Developer resources (Ethereum wiki) <https://github.com/ethereum/wiki/wiki/Dapp-Developer-Resources>`__


.. toctree::
   :maxdepth: 2
   :caption: Quick start

   layout
   file_explorer
   plugin_manager
   settings_tab
   terminal
   run_tab
   javascript_vm
   udapp

.. toctree::
   :maxdepth: 2
   :caption: Running remix locally

   packages

.. toctree::
   :maxdepth: 2
   :caption: Tour of typical modules

   solidity_editor
   compile_tab
   contract_metadata
   debugger_tab
   analysis_tab
   

.. toctree::
   :maxdepth: 2
   :caption: Testing

   unittesting_tab

.. toctree::
   :maxdepth: 2
   :caption: Other Remix features

   tutorial_remixd_filesystem

.. toctree::
   :maxdepth: 2
   :caption: Tutorials and workshops

   workshop_Building_smart_contracts_with_Remix
   tutorial_eattheblock
   tutorial_debug
   tutorial_import
   tutorial_mist

.. toctree::
   :maxdepth: 2
   :caption: Code contribution guide

   code_contribution_guide
   Community
   support_tab