Update README with new doc address and license

This commit is contained in:
Benjamin Canou 2018-07-06 14:45:35 +02:00 committed by Grégoire Henry
parent 6d59a497e7
commit 6c78c5bc25
4 changed files with 23 additions and 13 deletions

View File

@ -6,14 +6,19 @@ capability. Tezos not only comes to consensus about the state of its ledger,
like Bitcoin or Ethereum. It also attempts to come to consensus about how the like Bitcoin or Ethereum. It also attempts to come to consensus about how the
protocol and the nodes should adapt and upgrade. protocol and the nodes should adapt and upgrade.
- Developer documentation is available online at http://doc.tzalpha.net - Developer documentation is available online at http://tezos.gitlab.io/master
always in sync with the master branch (which may be desynchronized with
the code running on the live networks, replace `master` in the URL by the
branch of your choice: betanet, alphanet, zeronet, to make sure you are
consulting the right API version)
- The page https://www.tezos.com/ contains more information about the - The page https://www.tezos.com/ contains more information about the
project, even though it is frozen in time due to external reasons project, even though it is frozen in time due to external reasons
- All development now happens on Gitlab at https://gitlab.com/tezos/tezos - All development now happens on Gitlab at https://gitlab.com/tezos/tezos
The Tezos Alpha (test) network has been live and open since February 2017. The Tezos Alpha (test) network has been live and open since February 2017.
- More information on joining the Alphanet at http://doc.tzalpha.net/introduction/alphanet.html The Tezos Beta (experimental) network has been live and open since June 2018.
- Several community built block explorers are available: - Several community built block explorers are available:
- https://ostez.com - https://ostez.com
- https://tzscan.io - https://tzscan.io
@ -26,6 +31,4 @@ The Tezos Alpha (test) network has been live and open since February 2017.
- There is a *#tezos* channel on *freenode* that is reserved for technical discussions - There is a *#tezos* channel on *freenode* that is reserved for technical discussions
- There is also a community FAQ at https://github.com/tezoscommunity/faq - There is also a community FAQ at https://github.com/tezoscommunity/faq
The source code of Tezos is currently under exclusive copyright of The source code of Tezos is placed under the MIT Open Source License.
Dynamic Ledger Solutions, and will be open sourced under the MIT
license when the main network lunches.

View File

@ -2,7 +2,7 @@
Building documentation locally Building documentation locally
****************************** ******************************
The documentation is available online at `doc.tzalpha.net <http://doc.tzalpha.net/>`_, The documentation is available online at `tezos.gitlab.io <http://tezos.gitlab.io/master/>`_,
always up to date with master on `GitLab <https://gitlab.com/tezos/tezos>`_. always up to date with master on `GitLab <https://gitlab.com/tezos/tezos>`_.
Building instructions Building instructions

View File

@ -21,6 +21,8 @@
import os import os
import sys import sys
import datetime
from os import environ
sys.path.insert(0, os.path.abspath('.') + '/_extensions') sys.path.insert(0, os.path.abspath('.') + '/_extensions')
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -56,10 +58,10 @@ author = 'Dynamic Ledger Solutions, Inc. <contact@tezos.com>'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.0.1'
# The full version, including alpha/beta/rc tags.
release = '0.0.1'
version = os.environ.get('CI_COMMIT_REF_NAME', 'local')
# The full version, including alpha/beta/rc tags.
release = '(' + version + ' branch, ' + datetime.datetime.now().strftime(" %Y/%m/%d %H:%M)")
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
# #

View File

@ -12,13 +12,20 @@ capability. Tezos not only comes to consensus about the state of its ledger,
like Bitcoin or Ethereum. It also attempts to come to consensus about how the like Bitcoin or Ethereum. It also attempts to come to consensus about how the
protocol and the nodes should adapt and upgrade. protocol and the nodes should adapt and upgrade.
- Developer documentation is available online at http://doc.tzalpha.net - Developer documentation is available online at http://tezos.gitlab.io/master
always in sync with the master branch (which may be desynchronized with
the code running on the live networks, replace ``master`` in the URL by the
branch of your choice: betanet, alphanet, zeronet, to make sure you are
consulting the right API version)
- The official Tezos website https://tezos.com/ contains more information about the - The official Tezos website https://tezos.com/ contains more information about the
project. project.
- All development now happens on GitLab at https://gitlab.com/tezos/tezos - All development now happens on GitLab at https://gitlab.com/tezos/tezos
The Tezos Alpha (test) network has been live and open since February 2017. The Tezos Alpha (test) network has been live and open since February 2017.
The Tezos Beta (experimental) network has been live and open since June 2018.
- More information on joining the Alphanet at :ref:`here <alphanet>`. - More information on joining the Alphanet at :ref:`here <alphanet>`.
- Several community built block explorers are available: - Several community built block explorers are available:
@ -36,9 +43,7 @@ The Tezos Alpha (test) network has been live and open since February 2017.
- There is a *#tezos* channel on *freenode* that is reserved for technical discussions - There is a *#tezos* channel on *freenode* that is reserved for technical discussions
- There is also a community FAQ at https://github.com/tezoscommunity/faq/wiki/Tezos-Technical-FAQ - There is also a community FAQ at https://github.com/tezoscommunity/faq/wiki/Tezos-Technical-FAQ
The source code of Tezos is currently under exclusive copyright of The source code of Tezos is placed under the MIT Open Source License.
Dynamic Ledger Solutions, and will be open sourced under the MIT
license when the main network lunches.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2