diff --git a/docs/source/getting-started/index.rst b/docs/source/getting-started/index.rst index 4d784efcbd..b1f11baf65 100644 --- a/docs/source/getting-started/index.rst +++ b/docs/source/getting-started/index.rst @@ -40,7 +40,9 @@ If you haven't already, see :doc:`installation` for the DAML SDK and VSCode deve You will also need some common software tools to build and interact with the template project. - `Git `_ version control system -- `Yarn `_ package manager for Javascript +- `Yarn `_ package manager for Javascript. You have to have yarn version 1.10.0 or higher. + + Note: Ubuntu 17.04 and higher come with ``cmdtest`` package installed by default. If you are getting errors when installing yarn, you may want to run ``sudo apt remove cmdtest`` first and then install yarn. More information can be found `here `_ as well as in the official `yarn installation docs for Debian / Ubuntu `_ - A terminal application for command line interaction @@ -58,6 +60,8 @@ Next we need to compile the DAML code to a DAR file:: daml build +Once the DAR file is created you will see this message in terminal ``Created .daml/dist/create-daml-app-0.1.0.dar``. + Any commands starting with ``daml`` are using the :doc:`DAML Assistant `, a command line tool in the DAML SDK for building and running DAML apps. In order to connect the UI code to this DAML, we need to run a code generation step:: @@ -78,7 +82,7 @@ In one terminal, at the root of the ``create-daml-app`` directory, run the scrip ./daml-start.sh -This script is just shorthand for ``daml start`` with some arguments, which does a few things: +You will know that script has run successfully when you see the ``INFO com.digitalasset.http.Main$ - Started server: ServerBinding(/0:0:0:0:0:0:0:0:7575)`` message in terminal. The script is just shorthand for ``daml start`` with some arguments, which does a few things: 1. Compiles the DAML code to a DAR file as in the previous ``daml build`` step. 2. Starts an instance of the :doc:`Sandbox `, an in-memory ledger useful for development, loaded with our DAR.