From eee04671ff17237ce2548bc92ce0abe29fc70f57 Mon Sep 17 00:00:00 2001 From: Alexander Polynomdivision Date: Tue, 9 Oct 2018 16:25:32 +0200 Subject: [PATCH] docs: Fix formatting issues --- scripts/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/scripts/README.md b/scripts/README.md index 2791a63..91905e0 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -3,7 +3,7 @@ A few scripts to help with any task ## csv_vocab_to_mongo.py Parses the vocabulary files in `$REPO_ROOT/data/vocab/`, converts the vocabulary items -into a format that fits the database model for vocabulary items (see `backend/db.md**) and +into a format that fits the database model for vocabulary items (see `backend/db.md`) and writes the data into the MongoDB database. **NOTE**: Requires `pymongo` to be installed via pip @@ -17,7 +17,7 @@ writes the data into the MongoDB database. ## add_user.js Asks the user about his data (username, password, class** and adds the user to the database. -**NOTE**: Requires `mongodb** to be installed via npm +**NOTE**: Requires `mongodb` to be installed via npm **NOTE**: This script is written in JavaScript, so we can ensure that the same pbkdf2 function is used to create the user and to hash the password later on. @@ -31,12 +31,12 @@ to create the user and to hash the password later on. ## add_level.py Asks about a new level to add -**NOTE**: Requires `mongodb** to be installed via npm +**NOTE**: Requires `mongodb` to be installed via npm ### Usage - `URI`: The URI of the MongoDB instance -- `Database**: The name of the database in the MongoDB instance +- `Database`: The name of the database in the MongoDB instance ## generate_test_levels.py Generates 10 levels with names and a description. The name and the description are generated using @@ -48,4 +48,4 @@ Markov Chains, while the Bee Movie script serves as data for the model. ### Usage - `URI`: The URI of the MongoDB instance -- `Database**: The name of the database in the MongoDB instance +- `Database`: The name of the database in the MongoDB instance