Merge pull request #33 from salarx/azure-testing

Azure testing

Author: Sahil Kumar

README.md

@@ -1,80 +1,95 @@
 # FusionIIIT
 
-**FusionIIIT** is the automation of various functionalities, modules and tasks of/for PDPM Indian Institute of Information Technology, Design and Manufacturing, Jabalpur being developed in python3.6 and using django webframework version 1.11
+**FusionIIIT** is the automation of various functionalities, modules and tasks of/for **PDPM Indian Institute of Information Technology, Design and Manufacturing, Jabalpur** being developed in `python3.6` and using `Django` Webframework version `1.11`
 
 ## System Requirements
-Ubuntu 18.04 (or newer)
+
+* **Ubuntu `18.04`** (or newer) *OR*
+* **WSL** for **Windows 10** \(Follow the guide below\) :  
+    [Windows Subsystem for Linux Installation Guide for Windows 10](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
 
 ## Software Requirements
-* Python 3.6
-* PostgreSQL 10.10
+
+* Python `3.6`
+* PostgreSQL `10.10`
 * Git
 
 ## How to get started
 
-* Install the required packages using the following command : 
-`sudo apt install PostgreSQL PostgreSQL-contrib python3.6-dev python-virtualenv build-essential git`
+* Install the required packages using the following command :  
+    `sudo apt install PostgreSQL PostgreSQL-contrib python3.6-dev python-virtualenv build-essential git`
 
 ### Downloading the Code
-* Go to (https://github.com/salarx/Fusion) and click on **Fork**
-* You will be redirected to *your* fork, `https://github.com/<yourname>/Fusion`
-* Open the terminal, enter into the directory where you want to clone the Fusion repository using `cd <path_of_choice>/`
+
+* Go to (<https://github.com/salarx/Fusion)> and click on **Fork**
+* You will be redirected to *your* fork, `https://github.com/<your_user_name>/Fusion`
+* Open the terminal, change to the directory where you want to clone the **Fusion** repository
 * Clone your repository using `git clone https://github.com/<your_user_name>/Fusion`
 * Enter the cloned directory using `cd Fusion/`
 
 ### Run
-* Install virtualenv  
-    - on Ubuntu: `sudo apt install python-virtualenv`  
-    - on Windows Powershell `pip install virtualenv`  
+
+* Install *virtualenv*  
+  * on **Ubuntu**: `sudo apt install python-virtualenv`  
+  * on **Windows Powershell**: `pip install virtualenv`  
 * Create a virtual environment  
-    - on Ubuntu: `virtualenv env -p python3.6`  
-    - on Windows Powershell: `virtualenv env`
-* Activate the env
-    - on Ubuntu: `source env/bin/activate`  
-    - on Windows Powershell: `. .\env\scripts\activate`  
+  * on **Ubuntu**: `virtualenv env -p python3.6`  
+  * on **Windows Powershell**: `virtualenv env`
+* Activate the *env*
+  * on **Ubuntu**: `source env/bin/activate`  
+  * on **Windows Powershell**: `. .\env\scripts\activate`  
 * Install the requirements: `pip install -r requirements.txt`
 * Replace the files
-    - on Ubuntu: `env/lib/python3.6/site-packages/notifications`
-    - on Windows: `env/lib/site-packages/notifications`
-        - with the files in `notif_package_mod` folder inside the current directory
-* Change directory to FusionIIIT `cd FusionIIIT`
-* Make migrations `python manage.py makemigrations`  
+  * on **Ubuntu**: `env/lib/python3.6/site-packages/notifications`
+  * on **Windows**: `env/lib/site-packages/notifications`  
+with the files in **notif_package_mod** folder inside the current directory
+* Change directory to **FusionIIIT** `cd FusionIIIT`
+* Make *migrations* `python manage.py makemigrations`  
 * Migrate the changes to the database `$ python manage.py migrate`  
 * Run the server `python manage.py runserver`
 
 ### Setting upstream
+
 * `git remote add upstream https://github.com/salarx/Fusion`
-    - Adds the remote repository (the repository you forked from) so that changes can be pulled from/pushed to it. 
+  * Adds the remote repository (the repository you forked from) so that changes can be pulled from/pushed to it
 
 ## Working with Code \(Method 1\)
 
 ### Checking out
+
 * `git checkout -b <module-name>`
-    - Creates a new branch `<module-name>` in your repository.
+  * Creates a new branch `<module-name>` in your repository
 * `git checkout <module-name>`
-    - Switches to the branch you just created.
+  * Switches to the branch you just created
 
 ### Committing
+
 * `git add .`
-    - Adds the changes to the staging area
+  * Adds the changes to the staging area
 * `git commit`
-    - Commits the staged changes
+  * Commits the staged changes
 
 ### Syncing
+
 #### Pulling
+
 * `git pull upstream master`
-    - Pull the changes from the upstream master branch. Make sure you have no uncommited changes.
+  * Pulls the changes from the *upstream* master branch
+
 #### Pushing
+
 * `git push -u origin <module-name>`
-    - Push the changes to your repository \(First time only\). Using `git push` is sufficient later on. 
-* Go to `https://github.com/<your_user_name>/Fusion/tree/<module-name>` and create pull request.
+  * Pushes the changes to your repository **\(First time only\)**; using `git push` is sufficient later on
+* Go to `https://github.com/<your_user_name>/Fusion/tree/<module-name>` and create pull request
 
 ## Working with Code \(Alternative\)
-* **(Recommended)** Use [Visual Studio Code](https://code.visualstudio.com/) as a text editor. Go through the [Tutorial](https://code.visualstudio.com/docs/python/python-tutorial) for getting started with **Visual Studio Code for Python**.
-* Use the inbuilt **Source Control** feature for checking out, committing, pushing, pulling changes. You can also use [Github Desktop](https://desktop.github.com/) \(Windows/Mac only\).
-    Refer to below link for best practices regarding commit messages
-    - (https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53)
 
+* **(Recommended)** Use [Visual Studio Code](https://code.visualstudio.com/) as a text editor. Go through the [Tutorial](https://code.visualstudio.com/docs/python/python-tutorial) for getting started with **Visual Studio Code for Python**.  
+**Note** : Use the following guide if using **WSL** for Development  
+    (<https://code.visualstudio.com/docs/remote/wsl)>
+* Use the inbuilt **Source Control** feature for checking out, committing, pushing, pulling changes. You can also use [Github Desktop](https://desktop.github.com/) **_\(Windows/Mac only\)_**.  
+* Refer to below link for best practices regarding commit messages :  
+    (<https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53)>
 
 ## Different modules included