Merge pull request #1 from tmckay/master

Make a couple formatting and grammar changes to docs
toumorokoshi · Feb 9, 2015 · a4ce3a4 · a4ce3a4
2 parents 8dd0b3f + 8a103a9
commit a4ce3a4
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 14 deletions.
diff --git a/.gitignore b/.gitignore
@@ -60,4 +60,7 @@ target/
 *~
 man/
 pip-selfcheck.json
-.uranium
+.uranium
+
+# Vim
+.*.swp
diff --git a/docs/config.rst b/docs/config.rst
@@ -10,21 +10,21 @@ your service or library.
 The simplest uranium.yaml looks something like this:
 
 .. code-block:: yaml
-    # this is an example uranium.yaml file.
 
-    # develop-eggs is a list of directories containing eggs.
-    # uranium will install any eggs it can find in these directories
-    develop-eggs:
-      - ../sprinter/
+  # this is an example uranium.yaml file.
 
-    # eggs is a list of eggs to install. If an egg is already installed
-    # via develop-eggs above, it will ignore the egg declaration here.
-    eggs:
-      sprinter: null
+  # develop-eggs is a list of directories containing eggs.
+  # uranium will install any eggs it can find in these directories
+  develop-eggs:
+    - ../sprinter/
 
+  # eggs is a list of eggs to install. If an egg is already installed
+  # via develop-eggs above, it will ignore the egg declaration here.
+  eggs:
+    sprinter: null
 
 This tells uranium to:
 
 * start a virtualenv (this is built in to all uranium builds)
 * attempt to install an egg from ../sprinter/
-* install the egg 'sprinter' into it's sandbox.
+* install the egg 'sprinter' into its sandbox.
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,12 +11,12 @@ What is Uranium?
 ----------------
 
 Uranium is a build framework for Python. It's designed to help assist with the build process
-for Python services that require more than a virtual + "pip install -r requirements.txt". Some of the
+for Python services that require more than a virtualenv + "pip install -r requirements.txt". Some of the
 functionality includes:
 
-* a yaml-based configuration language
+* a YAML-based configuration language
 * the ability to share common configuration and setup
-* support for plugins, both for Uranium itself and for zc.buildout.
+* support for plugins, both for Uranium itself and for zc.buildout
 * (by 1.0) simplifying the installation and configuration process for
   native libraries that are needed for some Python libraries.