[Notes] [Git][BuildStream/buildstream][jennis/doc_improvements] 3 commits: README.md: Minor corrections



Title: GitLab

James Ennis pushed to branch jennis/doc_improvements at BuildStream / buildstream

Commits:

2 changed files:

Changes:

  • README.rst
    ... ... @@ -25,7 +25,7 @@ BuildStream offers the following advantages:
    25 25
     
    
    26 26
     * **Declarative build instructions/definitions**
    
    27 27
     
    
    28
    -  BuildStream provides a a flexible and extensible framework for the modelling
    
    28
    +  BuildStream provides a flexible and extensible framework for the modelling
    
    29 29
       of software build pipelines in a declarative YAML format, which allows you to
    
    30 30
       manipulate filesystem data in a controlled, reproducible sandboxed environment.
    
    31 31
     
    
    ... ... @@ -61,25 +61,29 @@ How does BuildStream work?
    61 61
     ==========================
    
    62 62
     BuildStream operates on a set of YAML files (.bst files), as follows:
    
    63 63
     
    
    64
    -* loads the YAML files which describe the target(s) and all dependencies
    
    65
    -* evaluates the version information and build instructions to calculate a build
    
    64
    +* Loads the YAML files which describe the target(s) and all dependencies.
    
    65
    +* Evaluates the version information and build instructions to calculate a build
    
    66 66
       graph for the target(s) and all dependencies and unique cache-keys for each
    
    67
    -  element
    
    68
    -* retrieves elements from cache if they are already built, or builds them in a
    
    69
    -  sandboxed environment using the instructions declared in the .bst files
    
    70
    -* transforms/configures and/or deploys the resulting target(s) based on the
    
    67
    +  element.
    
    68
    +* Retrieves previously built elements (artifacts) from a local/remote cache, or
    
    69
    +  builds the elements in a sandboxed environment using the instructions declared
    
    70
    +  in the .bst files.
    
    71
    +* Transforms/configures and/or deploys the resulting target(s) based on the
    
    71 72
       instructions declared in the .bst files.
    
    72 73
     
    
    73 74
     
    
    74 75
     How can I get started?
    
    75 76
     ======================
    
    76
    -The easiest way to get started is to explore some existing .bst files, for example:
    
    77
    +To start using BuildStream, first,
    
    78
    +`install <https://buildstream.gitlab.io/buildstream/main_install.html>`_
    
    79
    +BuildStream onto your machine and then follow our
    
    80
    +`tutorial <https://buildstream.gitlab.io/buildstream/using_tutorial.html>`_.
    
    81
    +
    
    82
    +We also recommend exploring some existing BuildStream projects:
    
    77 83
     
    
    78 84
     * https://gitlab.gnome.org/GNOME/gnome-build-meta/
    
    79 85
     * https://gitlab.com/freedesktop-sdk/freedesktop-sdk
    
    80 86
     * https://gitlab.com/baserock/definitions
    
    81
    -* https://gitlab.com/BuildStream/buildstream-examples/tree/master/build-x86image
    
    82
    -* https://gitlab.com/BuildStream/buildstream-examples/tree/master/netsurf-flatpak
    
    83 87
     
    
    84 88
     If you have any questions please ask on our `#buildstream <irc://irc.gnome.org/buildstream>`_ channel in `irc.gnome.org <irc://irc.gnome.org>`_
    
    85 89
     

  • doc/source/main_install.rst
    1 1
     Install
    
    2 2
     =======
    
    3
    -This section covers how to install BuildStream onto your machine, how to run BuildStream inside a docker image and also how to configure an artifact server.
    
    3
    +This section covers how to install BuildStream onto your machine, how to run
    
    4
    +BuildStream inside a docker image and also how to configure an artifact server.
    
    4 5
     
    
    6
    +.. note::
    
    7
    +
    
    8
    +   BuildStream is not currently supported natively on macOS and Windows. Windows
    
    9
    +   and macOS users should refer to :ref:`docker`.
    
    5 10
     
    
    6 11
     .. toctree::
    
    7 12
        :maxdepth: 2
    



  • [Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]