linting

README.md

@@ -5,11 +5,11 @@ in UI for the evaluation.
 
 In the test the rules are represented using [YAML](http://yaml.org/)
 
-
 ## Rule file format
 
 The structure follows this general model:
 
+```yaml
     unit: <Unit name>
       tasks:
        - name: Task name
@@ -18,6 +18,7 @@ The structure follows this general model:
          checklist: student checklist
        -..
       faq: Markdown faq
+```
 
 Take a look to the provided .yaml for a full example
 
@@ -25,21 +26,21 @@ Take a look to the provided .yaml for a full example
 
 This python 2 script takes all the yaml files in src/ and can:
 
-**Test them for correctness**
+### Test them for correctness
 
-   python build.py test
+   `python build.py test`
 
 This will simply check syntax and exit without errors if it's correct
 
-**Convert them to Markdown**
+### Convert them to Markdown
 
-   python build.py gitbook
+   `python build.py gitbook`
 
 This will generate a `gitbook` folder containing the Markdown formatted files.
 
-**Convert them to JSON**
+### Convert them to JSON
 
-   python build.py json
+   `python build.py json`
 
 This will generate a `json` folder containing the JSON formatted files.
 
@@ -47,11 +48,8 @@ This will generate a `json` folder containing the JSON formatted files.
 
 To be able to run build.py you need to intsall the packages in requirements.txt
 
-   pip install -r requirements.txt
+   `pip install -r requirements.txt`
 
 ## Next steps
 
-This format should allows us to build the gitbook and nueval version from the YAML files,
-so we might convert the remaining pagese using the format.
-
-
+This format should allow us to build the gitbook and nueval version from the YAML files, so we might convert the remaining pages using the format.