diff options
| author | James Ennis <james.ennis@codethink.com> | 2018-07-27 10:11:41 +0100 |
|---|---|---|
| committer | Javier Jardón <jjardon@gnome.org> | 2018-07-27 11:13:50 +0000 |
| commit | 196cfffce5cbd873bbd773409d8d55ed848e8fc5 (patch) | |
| tree | 1cec5c48cb44a2857683e13e6fb7eb586578c383 /README.rst | |
| parent | 23e080b90d896cffe289ab194092b65662d73dee (diff) | |
| download | buildstream-196cfffce5cbd873bbd773409d8d55ed848e8fc5.tar.gz | |
README.md: Direct users towards the tutorial before existing projects:
This patch also removes displaying the projects that live within
the buildstream-examples repository, as we wish to deprecate this
repo and migrate the two examples.
- #438 and #439
In addition to this, both examples do not 'build' in their current
state.
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/README.rst b/README.rst index ef1de89da..c553da068 100644 --- a/README.rst +++ b/README.rst @@ -74,13 +74,16 @@ BuildStream operates on a set of YAML files (.bst files), as follows: How can I get started? ====================== -The easiest way to get started is to explore some existing .bst files, for example: +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>`_. + +We also recommend exploring some existing BuildStream projects: * https://gitlab.gnome.org/GNOME/gnome-build-meta/ * https://gitlab.com/freedesktop-sdk/freedesktop-sdk * https://gitlab.com/baserock/definitions -* https://gitlab.com/BuildStream/buildstream-examples/tree/master/build-x86image -* https://gitlab.com/BuildStream/buildstream-examples/tree/master/netsurf-flatpak If you have any questions please ask on our `#buildstream <irc://irc.gnome.org/buildstream>`_ channel in `irc.gnome.org <irc://irc.gnome.org>`_ |