Update README.md

Linked issues to [BUG] repo_logistics readme.md bitprj#159

repo_logistics/README.md

@@ -2,21 +2,21 @@
 
 ### What's in `repo_logistics/`?
 
-* In the `sample-camp` directory, you will find a template subdirectory for how each Bitcamp documentation should be structured.
+* In the `learning_lab` directory, you will find instructions to create your very own [Github Learning Lab](https://lab.github.com/).
+* In the `sample-camp` directory, you will find a template for the Bitcamp schedule and the curriculum.
   * This README.md file will give a brief overview of where everything is located.
-  * If you need a reference to a complete Bitcamp documentation, click [here](https://github.com/bitprj/BitCamp/tree/master/Serverless-Functions)
-* In the `learning_lab` directory, you will find instructions to create your very own Github Learning Lab from your curriculum.
-* In this README.md, learn about the Github Action that creates Learning Labs
+  * Here is a sample of how the Bitcamp documentation should look [like](https://github.com/bitprj/BitCamp/tree/master/Serverless-Functions)
+* In this README.md, you will find the explanation about Github Action and Learning Labs.
 
 ---
 
 ## :collision: The Github Action
 
-The Github Action automatically generates the needed files to create a Github Learning Lab. Refer to the below documentation for formatting requirements and how it works:
+The Github Action can provide you an easier way to work with Github Learning Lab. Below are the steps how to create a good format for Github Action.
 
 ### :one: Input and Output
 
-**User must provide:**
+**You must provide:**
 - Response files in `/camp-name/homework/responses`
 - `course-details.md` file in `/camp-name/homework/course-details.md`
 
@@ -28,7 +28,7 @@ Note: "camp-name" is whatever the Bit Camp is called. If we were to create files
 
 ### :two: Formatting Requirements
 
-In order for the Action to successfully parse content, the files **must** be named and formatted like so:
+The files **must** be named and formatted like so:
 
 #### Response files
 
@@ -39,8 +39,8 @@ File name format: `[Week#].[Step#]-[Step title].md`
 File path: `/Serverless-Functions/homework/responses/[all response files]`
 
 File content: 
-* Response files are to be **titled with h2** at the very beginning of each markdown file. The title at the top will be the same title used in Github Learning Labs (what is in the config.yml file). 
-* The **description** of the step should be placed directly under formatted in **h4**.
+* Response files should use **h2 title** at the very beginning of each markdown file. The title will be the same one used in config.yml that is located in `/camp-name/homework/config.yml`
+* The **description** of the step should be formatted in **h4**.
 
 > Example:
 ```md
@@ -66,10 +66,11 @@ File content:
 
 *Course description*
 ```
+Refer [here](https://github.com/emsesc/sample-learninglab) to view the sample containing correctly formatted file names and structures.
 
 ### :three: Specifying the Camp name
 
-The Github Action will not run the Python file until a subdirectory (ie. Serverless-Functions) is specified. To do so, edit the `learninglabauto.py` file's `subdir` value.
+The Github Action will not run the Python file until a subdirectory (ie. Serverless-Functions) is specified. To do so, open the `learninglabauto.py` file under `scripts/` folder and edit the file's `subdir` value.
 
 **Before:**
 ```py
@@ -89,9 +90,7 @@ if subdir == "":
 
 ### :four: Finishing up
 
-Once both the change to the `learninglabauto.py` file in `scripts/` and the addition of the other files are committed, the Github Action should trigger and run.
-
-Linked [here](https://github.com/emsesc/sample-learninglab) is a sample containing correctly formatted file names and structures.
+Once the `learninglabauto.py` file and the other files are committed, the Github Action should trigger and run.
 
 Watch this video for a walkthrough:
 [![Watch the video](https://cdn.loom.com/sessions/thumbnails/d21df3bc8776488b81c6682449e81776-with-play.gif)](https://www.loom.com/share/d21df3bc8776488b81c6682449e81776)
@@ -136,15 +135,15 @@ Maintaining a consistent Bitcamp Curriculum documentation throughout all Bitcamp
  * `...`
  * `README.md`
 
-***Throughout this walkthrough, the corresponding files/directories within `sample-camp/` will be linked for your reference***
+***`sample-camp/` file will be linked for your reference***
 
 ### :book: [The root README.md file](https://github.com/emsesc/BitCamp/blob/sample-camp/repo_logistics/sample-camp/README.md)
 
 **What is it?**
 
-This is the general README.md file under your camp's [subdirectory](https://github.com/emsesc/BitCamp/tree/sample-camp/repo_logistics/sample-camp). This contains a general overview of the entire camp and quick summaries of each week.
+This contains a general overview of the entire camp and quick summaries of each week, which is located under your camp's [subdirectory](https://github.com/emsesc/BitCamp/tree/sample-camp/repo_logistics/sample-camp). 
 
-**Purpose:** This is for open-source contributors to understand what the camp's goals are and what the curriculum contains. This should NOT be as detailed as individual week descriptions. Be as clear and concise as possible.
+**Purpose:** This can help open-source contributors to understand what the camp's goals are and what the curriculum contains. Make sure to make it clear and be as detailed as possible.
 
 
 
@@ -154,23 +153,23 @@ This is the general README.md file under your camp's [subdirectory](https://gith
 
 This is the `homework/` in your camp's [subdirectory](https://github.com/emsesc/BitCamp/tree/sample-camp/repo_logistics/sample-camp). This contains all of the files needed to create your camp's Learning Lab.
 
-**Purpose:** To easily sync response files and other Learning Lab materials, placing all files under this subdirectory makes your life easier. This also keeps all files related to the camp in one place for easy access.
+**Purpose:** To keep all files related to the camp in one place, please place all files under this subdirectory for easy access.
 
-*We will not go over the file structure in this markdown file, so refer to the [`learning_lab`](https://github.com/bitprj/BitCamp/tree/master/repo_logistics/learning_lab) subdirectory for documentation on Learning Lab components.*
+*Refer to the [`learning_lab`](https://github.com/bitprj/BitCamp/tree/master/repo_logistics/learning_lab) subdirectory to go over the file structure in this markdown file.
 
 ### :file_folder: [Week Folders](https://github.com/emsesc/BitCamp/blob/sample-camp/repo_logistics/sample-camp)
 
 **What is it?**
 
-These are directories within the camp [subdirectory](https://github.com/emsesc/BitCamp/blob/sample-camp/repo_logistics/sample-camp) that organize the content by weeks. Create as many as you need accordingly to the camp's weeks.
+These are [subdirectories](https://github.com/emsesc/BitCamp/blob/sample-camp/repo_logistics/sample-camp) that organize the content by weeks. Create as many as you need accordingly to the camp's weeks.
 
-**Purpose:** These directories each contain the week's README.md (individual week description), livestream, and homework.
+**Purpose:** Each directory contain the week's README.md (individual week description), livestream, and homework.
 
 ### :open_file_folder: [Inside the Week Folders](https://github.com/emsesc/BitCamp/blob/sample-camp/repo_logistics/sample-camp/week1)
 
 **What is it?**
 
-Inside the Week Directories, there are three components: code, videos, and the README.md (individual week description).
+These consist of three components: code, videos, and the README.md (individual week description).
 
 * **`code`**: this contains the **code** you will use in the livestream.
 * **`videos`**: this contains the **video recordings** of the livestream.