diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-08-26 16:48:31 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-08-26 17:11:56 +0900 |
| commit | 0f3292765ff038d80e3f2ce4c0bc1b9f0266c950 (patch) | |
| tree | 231368c955b5aa3dc024567b6ac6ba1cb51ce7ba | |
| parent | fa6963070e0368c62de147c63ddde535e30aad3b (diff) | |
| download | buildstream-tristan/readme-version.tar.gz | |
README.rst: Use stronger language to follow the installation guide.tristan/readme-version
And also refer to the user guide section instead of directly to the
tutorial, the tutorial will still be the first section of the user
guide so this is a better link target for getting started.
This is related to #528
| -rw-r--r-- | README.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/README.rst b/README.rst index 6bbe6f4c1..dc1ed5d3d 100644 --- a/README.rst +++ b/README.rst @@ -69,10 +69,10 @@ BuildStream operates on a set of YAML files (.bst files), as follows: How can I get started? ====================== -To start using BuildStream, first, -`install <https://buildstream.gitlab.io/buildstream/main_install.html>`_ -BuildStream onto your machine and then follow our -`tutorial <https://buildstream.gitlab.io/buildstream/using_tutorial.html>`_. +To get started, first `install BuildStream by following the installation guide +<https://buildstream.gitlab.io/buildstream/main_install.html>`_ +and then follow our tutorial in the +`user guide <https://buildstream.gitlab.io/buildstream/main_using.html>`_. We also recommend exploring some existing BuildStream projects: @@ -81,4 +81,3 @@ We also recommend exploring some existing BuildStream projects: * https://gitlab.com/baserock/definitions If you have any questions please ask on our `#buildstream <irc://irc.gnome.org/buildstream>`_ channel in `irc.gnome.org <irc://irc.gnome.org>`_ - |