Formatted rest of README.

1 files changed, 100 insertions, 163 deletions

diff --git a/README.md b/README.md
index 57d9afa..a9975d9 100644
--- a/README.md
+++ b/README.md
@@ -70,7 +70,7 @@ OUT_DIR/[SCHED_(FILE|DIR)/]
         exec-err.txt  # Standard err '''
 ```
 
-*Defaults*: `SCHED_FILE = sched.py, PARAM_FILE = params.py, DURATION = 30, OUT_DIR = run-data/`
+*Defaults*: `SCHED_FILE = sched.py`, `PARAM_FILE = params.py`, `DURATION = 30`, `OUT_DIR = run-data/`
 
 This script reads *schedule files* (described below) and executes real-time task systems, recording all overhead, logging, and trace data which is enabled in the system. For example, if trace logging is enabled, rt-kernelshark is found in the path, but feather-trace is disabled (the devices are not present), only trace logs and rt-kernelshark logs will be recorded.
 
@@ -90,7 +90,7 @@ Schedule files have one of the following two formats:
        [real_time_task] task_arguments...
 ```
 
-b) python format
+2. python format
 ```python
        {'proc':[
            ('path/to/proc','proc_value'),
@@ -142,7 +142,7 @@ $ echo "release_master{2}
 A longer form can be used for proc entries not under `/proc/litmus`:
 
 ```bash
-$ echo "/proc/sys/something{hello}"
+$ echo "/proc/sys/something{hello}
 10 20" > test.sched
 ```
 
@@ -152,7 +152,7 @@ You can specify your own spin programs to run as well instead of rtspin by putti
 $ echo "colorspin -f color1.csv 10 20" > test.sched
 ```
 
-You can specify parameters for an experiment in a file instead of on the command line using params.py (the `-p` option lets you choose the name of this file if params.py is not for you):
+You can specify parameters for an experiment in a file instead of on the command line using params.py (the `-p` option lets you choose the name of this file if `params.py` is not for you):
 
 ```bash
 $ echo "{'scheduler':'GSN-EDF', 'duration':10}" > params.py
@@ -166,26 +166,19 @@ You can include non-relevant parameters which `run_exps.py` does not understand
 ```bash
 $ mkdir test1
 # The duration will default to 30 and need not be specified
-$ echo "{'scheduler':'C-EDF', 'test-param':1} > test1/params.py
+$ echo "{'scheduler':'C-EDF', 'test-param':1}" > test1/params.py
 $ echo "10 20" > test1/sched.py
 $ cp -r test1 test2
 $ echo "{'scheduler':'GSN-EDF', 'test-param':2}"> test2/params.py
 $ run_exps.py test*
 ```
 
-Finally, you can specify system properties in `params.py` which the environment must match for the experiment to run. These are useful if you have a large batch of experiments which must be run under different kernels or kernel configurations. The first property is a regular expression for the name of the kernel:Invalid environment for experiment 'test.sched'
-Kernel name does not match '.*linux.*'.
-Experiments run:        1
-  Successful:           0
-  Failed:               0
-  Already Done:         0
-  Invalid Environment:  1
+Finally, you can specify system properties in `params.py` which the environment must match for the experiment to run. These are useful if you have a large batch of experiments which must be run under different kernels or kernel configurations. The first property is a regular expression for the name of the kernel:
 
 ```bash
 $ uname -r
 3.0.0-litmus
-$ cp params.py old_params.py
-$ echo "{'uname': r'.*linux.*'}" >> params.py
+$ echo "{'uname': r'.*linux.*'}" > params.py
 $ run_exps.py -s GSN-EDF test.sched
 Invalid environment for experiment 'test.sched'
 Kernel name does not match '.*linux.*'.
@@ -194,51 +187,41 @@ Experiments run:        1
   Failed:               0
   Already Done:         0
   Invalid Environment:  1
-$ cp old_params.py params.py
-$ echo "{'uname': r'.*litmus.*'}" >> params.py
+$ echo "{'uname': r'.*litmus.*'}" > params.py
 # run_exps.py will now succeed
 ```
 
-The second property is kernel configuration options. These assume the configuration is stored at `/boot/config-```uname -r`` `. You can specify these like so:
+The second property is kernel configuration options. These assume the configuration is stored at `/boot/config-$(uname -r)`. You can specify these in `params.py` like so:
 
-```bash
-# Only executes on ARM systems with the release master enabled
-$ echo "{'config-options':{
-'RELEASE_MASTER' : 'y',
-'ARM' : 'y'}}" >> params.py
+```python
+{'config-options':{
+        'RELEASE_MASTER' : 'y',
+        'ARM' : 'y'}
+}
 ```
 
 
-III. GEN_EXPS
-Usage: gen_exps.py [options] [files...] [generators...] [param=val[,val]...]
-Output:   exps/EXP_DIRS which each contain sched.py and params.py
-Defaults: generators = G-EDF P-EDF C-EDF
+## gen_exps.py
+*Usage*: `gen_exps.py [options] [files...] [generators...] [param=val[,val]...]`
 
-The gen_exps.py script uses 'generators', one for each LITMUS
-scheduler supported, which each have different properties which can be
-varied to generate different types of schedules. Each of these
-properties has a default value which can be modified on the command
-line for quick and easy experiment generation.
+*Output*:   OUT_DIR/EXP_DIRS which each contain sched.py and params.py
 
-This script as written should be used to create debugging task sets,
-but not for creating task sets for experiments shown in papers. That
-is because the safety features of run_exps.py described above (uname,
-config-options) are not used here. If you are creating experiments for
-a paper, you should create your own generator which outputs values for
-'config-options' required for your plugin so that you cannot ruin your
-experiments at run time.
+*Defaults*: `generators = G-EDF P-EDF C-EDF`, `OUT_DIR = exps/`
 
-The -l option lists the supported generators which can be specified:
+This script uses *generators*, one for each LITMUS scheduler supported, which each have different properties which can be varied to generate different types of schedules. Each of these properties has a default value which can be modified on the command line for quick and easy experiment generation.
 
+This script as written should be used to create debugging task sets, but not for creating task sets for experiments shown in papers. That is because the safety features of `run_exps.py` described above (uname, config-options) are not used here. If you are creating experiments for a paper, you should create your own generator which outputs values for the `config-options` required for your plugin so that you cannot ruin your experiments at run time. Trust me, you will.
+
+The `-l` option lists the supported generators which can be specified:
+
+```bash
 $ gen_exps.py -l
 G-EDF, P-EDF, C-EDF
+```
 
-The -d option will describe the properties of a generator or
-generators and their default values. Note that some of these defaults
-will vary depending on the system the script is run. For example,
-'cpus' defaults to the number of cpus on the current system, in this
-example 24.
+The `-d` option will describe the properties of a generator or generators and their default values. Note that some of these defaults will vary depending on the system the script is run. For example, the `cpus` parameter defaults to the number of cpus on the current system, in this example 24.
 
+```bash
 $ gen_exps.py -d G-EDF,P-EDF
 Generator GSN-EDF:
         num_tasks -- Number of tasks per experiment.
@@ -254,102 +237,80 @@ Generator PSN-EDF:
                 Default: [24]
                 Allowed: <type 'int'>
         ....
+```
 
-You create experiments by specifying a generator. The following will
-create experiments 4 schedules with 24, 48, 72, and 96 tasks, because
-the default value of num_tasks is an array of these values
+You create experiments by specifying a generator. The following will create experiments 4 schedules with 24, 48, 72, and 96 tasks, because the default value of `num_tasks` is an array of these values (see above).
 
+```bash
 $ gen_exps.py P-EDF
 $ ls exps/
 sched=GSN-EDF_num-tasks=24/  sched=GSN-EDF_num-tasks=48/
 sched=GSN-EDF_num-tasks=72/  sched=GSN-EDF_num-tasks=96/
+```
 
-You can modify the default using a single value (the -f option deletes
-previous experiments in the output directory, defaulting to 'exps/',
-changeable with -o):
+You can modify the default using a single value (the `-f` option deletes previous experiments in the output directory, defaulting to `exps/`, changeable with `-o`):
 
+```bash
 $ gen_exps.py -f P-EDF num_tasks=24
 $ ls exps/
 sched=GSN-EDF_num-tasks=24/
+```
 
 Or with an array of values, specified as a comma-seperated list:
 
+```bash
 $ gen_exps.py -f num_tasks=`seq -s, 24 2 30` P-EDF
 sched=PSN-EDF_num-tasks=24/  sched=PSN-EDF_num-tasks=26/
 sched=PSN-EDF_num-tasks=28/  sched=PSN-EDF_num-tasks=30/
+```
 
-The generator will create a different directory for each possible
-configuration of the parameters. Each parameter which is varied is
-included in the name of the schedule directory. For example, to vary
-the number of CPUs but not the number of tasks:
+The generator will create a different directory for each possible configuration of the parameters. Each parameter which is varied is included in the name of the schedule directory. For example, to vary the number of CPUs but not the number of tasks: