A peer-to-peer stack for code collaboration
Cleanup readme and other docs
Thomas Scholtes7a7a67ca6364
diff --git a/README.md b/README.mdindex 26bb4a5..a977ea0 100644--- a/README.md+++ b/README.md@@ -1,42 +1,37 @@# radicle-> because 'tis the Origin of the Root... The Radicle is likewise called the-seminal Root.-> - Vallemont, *Curiosities of nature and art in husbandry and gardening* (1707)+> because 'tis the Origin of the Root... The Radicle is likewise called the seminal Root.+> — Vallemont, *Curiosities of nature and art in husbandry and gardening* (1707)A LISP in the spirit of [Black](http://pllab.is.ocha.ac.jp/~asai/Black/) andother colors. Easily define and interact with shared and upgradable statemachines.-## Installation--Install [stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/). Then:-```-stack build-```+Radicle has a [webpage](http://radicle.xyz/), and a [Getting Started+Guide](http://docs.radicle.xyz/en/latest/guide/GettingStarted.html) which+contain a lot more information on `radicle`.-(You'll need libpq-dev/postgresql to build the server. See [GettingStarted](https://radicle.readthedocs.io/en/latest/guide/GettingStarted.html) for more info.+## Installation-## How to run tests+You need [stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/) and `libpq-dev`.```-stack test+stack install```-## How to run executables--Running scripts and a REPL are the same thing - some scripts (in particular-`rad/repl.rad`) just *define* a REPL.--You should probably run the client against radicle.xyz for fuller-functionality.+## Usage```-stack exec radicle-client -- --config rad/repl.rad+radicle ./rad/repl.rad+rad> (print! "hello world")+rad> (def-rec fac (fn [n] (if (eq? n 0) 1 (* n (fac (- n 1))))))+rad> (fac 6)```-## More+## Development-Radicle has a [webpage](http://radicle.xyz/), and a [guide](http://docs.radicle.xyz) which-contain a lot more information on `radicle`.+You can run tests with `stack test`.+The documentation is build with `make -C docs html`. Reference documentation for+Radicle code must be regenerated with `stack run radicle-doc-ref` and checked+into version control.diff --git a/docs/source/guide/GettingStarted.rst b/docs/source/guide/GettingStarted.rstindex c63f2b0..0dfffe7 100644--- a/docs/source/guide/GettingStarted.rst+++ b/docs/source/guide/GettingStarted.rst@@ -28,7 +28,7 @@ http://git.oscoin.io/radicle:.. code-block:: bash- git clone http://git.oscoin.io/radicle+ git clone https://github.com/oscoin/radicle.gitcd radiclestack buildstack install@@ -46,4 +46,4 @@ file (included in the repository):.. code-block:: bash- radicle --config rad/repl.rad+ radicle rad/repl.rad