Permalink
Browse files

Update the README

With: Arthur B <arthur.breitman@gmail.com>
  • Loading branch information...
klakplok committed Feb 20, 2018
1 parent ac0a685 commit 71556b94188b938893bd624651080b5cdb90946f
View

This file was deleted.

Oops, something went wrong.
View
@@ -0,0 +1,31 @@
Tezos
=====
Tezos is a distributed consensus platform with meta-consensus
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
protocol and the nodes should adapt and upgrade.
- Developer documentation is available online at http://doc.tzalpha.net
- The page https://www.tezos.com/ contains more information about the
project, even though it is frozen in time due to external reasons
- 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.
- More information on joining the Alphanet at http://doc.tzalpha.net/introduction/alphanet.html
- Several community built block explorers are available:
- https://ostez.com
- https://tzscan.io
- https://tezos.id
- https://tezoschain.io
- A few community run websites collect useful Tezos links:
- https://tezos.help
- https://tezos.rocks
- There is a matrix channel *Tezos* that you can join via https://riot.im/app/#/room/#tezos:matrix.org
- 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
The source code of Tezos is currently under exclusive copyright of
Dynamic Ledger Solutions, and will be open sourced under the MIT
license when the main network lunches.
View
@@ -10,14 +10,11 @@ all: html linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)"
introduction/readme.rst: ../README.rst
sed 's/TEZOS/How to build and run/' $< > $@
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
html: Makefile introduction/readme.rst
html: Makefile
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
clean:
View
@@ -2,10 +2,13 @@
Building documentation locally
******************************
The documenation is available online at `doc.tzalpha.net <http://doc.tzalpha.net/>`_,
always up to date with master on `Gitlab <https://gitlab.com/tezos/tezos>`_.
Building instructions
---------------------
To build the documentaion, you can use the main Makefile target ``doc-html``
To build the documentation, you can use the main Makefile target ``doc-html``
.. code:: bash
View
@@ -173,3 +173,7 @@
author, 'Tezos', 'One line description of project.',
'Miscellaneous'),
]
# -- Ignore fragments in linkcheck
linkcheck_anchors = False
View
@@ -3,14 +3,48 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Tezos's documentation!
=================================
Welcome to the Tezos Developper Documentation!
==============================================
Tezos is a distributed consensus platform with meta-consensus
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
protocol and the nodes should adapt and upgrade.
- Developer documentation is available online at http://doc.tzalpha.net
- The page https://www.tezos.com/ contains more information about the
project, even though it is frozen in time due to external reasons
- 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.
- More information on joining the Alphanet at :ref:`here <alphanet>`.
- Several community built block explorers are available:
- http://ostez.com
- http://tzscan.io
- https://tezos.id
- https://tezoschain.io
- A few community run websites collect useful Tezos links:
- http://www.tezos.help
- https://tezos.rocks
- There is a matrix channel *Tezos* that you can join `here <https://riot.im/app/#/room/#tezos:matrix.org>`_.
- 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
The source code of Tezos is currently under exclusive copyright of
Dynamic Ledger Solutions, and will be open sourced under the MIT
license when the main network lunches.
.. toctree::
:maxdepth: 2
:caption: Introduction:
introduction/readme
introduction/howto
introduction/contributing
.. toctree::
@@ -1,3 +1,5 @@
.. _alphanet:
Participating in the Alphanet
=============================

This file was deleted.

Oops, something went wrong.

This file was deleted.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit 71556b9

Please sign in to comment.