Merge pull request #805 from ethereum/docs

Change links and index.md
pull/7/head
Nina Breznik 7 years ago committed by GitHub
commit dbdc576fd0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 12
      docs/conf.py
  2. 5
      docs/debugger_tab.md
  3. 36
      docs/index.md

@ -45,9 +45,8 @@ source_suffix = '.md'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Remix' project = u'Remix, Ethereum-IDE'
copyright = u'2017, yann300' copyright = u'2018, Remix'
author = u'yann300'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@ -93,6 +92,8 @@ exclude_patterns = ['_build']
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'
highlight_language = 'Solidity'\
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
#modindex_common_prefix = [] #modindex_common_prefix = []
@ -107,7 +108,8 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'sphinx_rtd_theme' html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
@ -136,7 +138,7 @@ html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = []
# Add any extra paths that contain custom files (such as robots.txt or # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied

@ -9,4 +9,7 @@ features).
![image](images/remix_debuggertab.png) ![image](images/remix_debuggertab.png)
For more information about debugging, click on the following link: For more information about debugging, click on the following link:
../tutorial\_debug .. toctree::
:maxdepth: 2
tutorial_debug.md

@ -1,36 +1,24 @@
Remix - Solidity IDE Remix - Solidity IDE
==================== ====================
Remix is Ethereum IDE for the smart contract programming language Solidity and ##Welcome to Remix!
has an integrated debugger and testing environment. We hope our tool will help you efficiently write, test, debug
and deploy Solidity contracts straight from your browser.
An up to date online version is available at ##Useful links
[remix.ethereum.org](http://remix.ethereum.org) If you are just getting started, this is a set of recommended resources and links:
* [REMIX](http://remix.ethereum.org)
* [Documentation about Solidity language](https://solidity.readthedocs.io)
* [Remix support/community chat](https://gitter.im/ethereum/remix)
* [Remix Github repository](https://github.com/ethereum/remix-ide)
Please go to [solidity.readthedocs.io](http://solidity.readthedocs.io) ##Getting started
for any information regarding `Solidity` To see how Remix works and how you can build your first simple contract, [click
here to get started](quickstart_javascript_vm.md)
Overview
-------- --------
Remix provides an integrated development environment (IDE) for smart
contract development. It focuses on the development and deployment of
Solidity written smart contracts.
Remix is a good solution if you intend to:
> - Develop smart contracts (remix integrates a solidity editor).
> - Debug a smart contract's execution.
> - Access the state and properties of already deployed smart
> contract.
> - Debug already committed transaction.
> - Analyze solidity code to reduce coding mistakes and to enforce
> best practices.
> - Together with Mist (or any tool which inject web3), Remix can be
> used to test and debug a Dapp (see ../tutorial\_mist)
Developing smart contract requires deep understanding of the
associated Blockchain technology.
Contents Contents
======== ========

Loading…
Cancel
Save