[buildstream] 02/07: removed example repo and modified docs

[no...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

not-in-ldap pushed a commit to branch spellcheck
in repository https://gitbox.apache.org/repos/asf/buildstream.git

commit f3fc16aad027a44dc4509c25f5b8211280c2407c
Author: Phillip Smyth <ph...@ct-lt-nexus.unassigned>
AuthorDate: Wed Dec 20 15:37:35 2017 +0000

    removed example repo and modified docs
---
 doc/source/buildproject.rst                      |   6 +--
 doc/source/example_projects/gnome-modulesets.tar | Bin 5836800 -> 0 bytes
 doc/source/install.rst                           |  53 +++++++++++++++++++----
 3 files changed, 47 insertions(+), 12 deletions(-)

diff --git a/doc/source/buildproject.rst b/doc/source/buildproject.rst
index 8b71855..1088eeb 100644
--- a/doc/source/buildproject.rst
+++ b/doc/source/buildproject.rst
@@ -21,12 +21,10 @@ in the directory you want to use
 
 ----
 
-If not already installed, install `git`
-
 This example will be using `gnome-modulesets`, but this will apply to any buildable repo
 
-Download :download:`gnome modulesets <example_projects/gnome-modulesets.tar>`
- 
+Download or clone `gnome-Modulesets  <http://gnome7.codethink.co.uk/gnome-modulesets.git/>`_
+
 Then move into the repo
 
 Building
diff --git a/doc/source/example_projects/gnome-modulesets.tar b/doc/source/example_projects/gnome-modulesets.tar
deleted file mode 100644
index 5c420ac..0000000
Binary files a/doc/source/example_projects/gnome-modulesets.tar and /dev/null differ
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 1112c58..f307cd0 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -2,16 +2,20 @@
 
 BuildStream on your host
 ========================
+
 Until BuildStream is available in your distro, there are a few hoops to jump
 through to get started.
 
+
 If your system cannot provide the base system requirements for BuildStream,
 then we have some instructions below which can get you started using BuildStream
 within a Docker container.
 
 
+
 System requirements
 -------------------
+
 BuildStream requires the following base system requirements:
 
 * python3 >= 3.4
@@ -23,28 +27,35 @@ BuildStream requires the following base system requirements:
 * gobject-introspection
 
 
+
 Note that ``ruamel.yaml`` is a pure python library which is normally
-obtainable via pip, however there seems to be some problems with installing
+obtainable via pip, however, there seem to be some problems with installing
 this package so we recommend installing it with your package manager first.
 
 For the purpose of installing BuildStream while there are no distro packages,
 you will additionally need:
 
+
 * pip for python3 (only required for setup)
+
 * Python 3 development libraries and headers
 
+
 Here are some examples of how to prepare the base requirements on
 some distros.
 
+
 Arch
 ~~~~
-Install the dependencies with:
+
+Install the dependencies with::
 
   sudo pacman -S python python-pip python-gobject git \
                  ostree bubblewrap python-ruamel-yaml
 
 Debian Stretch
 ~~~~~~~~~~~~~
+
 With stretch, you first need to ensure that you have the backports repository
 setup as described `here <https://backports.debian.org/Instructions/>`_
 
@@ -56,19 +67,22 @@ And then running::
 
   sudo apt-get update
 
-At this point you should be able to get the system requirements with::
+At this point, you should be able to get the system requirements with::
+
 
   sudo apt-get install \
       python3-dev python3-pip git python3-gi \
       python3-ruamel.yaml bubblewrap
+  
   sudo apt-get install -t stretch-backports \
       gir1.2-ostree-1.0 ostree
 
 
+
 Debian Buster or Sid
 ~~~~~~~~~~~~~~~~~~~~~
 
-For debian unstable or testing, the following line should be enough
+For Debian unstable or testing, the following line should be enough
 to get most of the base system requirements installed::
 
   sudo apt-get install \
@@ -78,60 +92,83 @@ to get most of the base system requirements installed::
       bubblewrap ruamel.yaml
       bubblewrap python3-ruamel.yaml
 
+
 Fedora
 ~~~~~~
 
-For recent fedora systems, the following line should get you the system
+
+For recent Fedora systems, the following line should get you the system
 requirements you need::
 
+
   dnf install -y bubblewrap fuse git python3-gobject \
                  python3-psutil ostree
 
-
 User installation with pip
 --------------------------
+
 Once you have the base system dependencies, you can clone the buildstream
 git repository and install it as a regular user::
 
+
   git clone https://gitlab.com/BuildStream/buildstream.git
+
   cd buildstream
+
   pip3 install --user .
 
+
 This will install buildstream and it's pure python dependencies directly into
-your user's homedir in ``~/.local``
+your user's home dir in ``~/.local``
+
 
 
 Adjust PATH
 ~~~~~~~~~~~
+
 Since BuildStream is now installed under your local user's install directories,
 you need to ensure that ``PATH`` is adjusted.
 
 A regular way to do this is to add the following line to the end of your ``~/.bashrc``::
 
+
   export PATH=${PATH}:~/.local/bin
 
 
+
 Bash Completions
+
 ~~~~~~~~~~~~~~~~
+
 Bash completions are supported by sourcing the ``buildstream/data/bst``
 script found in the BuildStream repository. On many systems this script
 can be installed into a completions directory but when installing BuildStream
-without a package manager this is not an option.
+without a package manager, this is not an option.
+
 
 To enable completions for an installation of BuildStream you
 installed yourself from git, just append the script verbatim
 to your ``~/.bash_completion``:
 
+
 .. literalinclude:: ../../buildstream/data/bst
+
    :language: yaml
 
 
 Upgrading with pip
 ~~~~~~~~~~~~~~~~~~
+
 To upgrade a previously install BuildStream, you will need to pull the latest
 changes and reinstall as such::
 
+
   pip3 uninstall buildstream
+
   cd buildstream
+
   git pull --rebase
+
   pip3 install --user .
+
+