Merge pull request #682 from adityacp/update_readme

Update README

2 files changed, 67 insertions, 27 deletions

diff --git a/README.rst b/README.rst
index 9361243..c730fdf 100644
--- a/README.rst
+++ b/README.rst
@@ -29,41 +29,65 @@ Features
 -  Scales to over 500+ simultaneous users.
 -  Distributed under the BSD license.
 
-Quick Start
-===========
+Requirements
+============
+
+Python 3.6, 3.7, 3.8
 
-Pre-Requisites
-^^^^^^^^^^^^^^
+Django 3.0.3
 
-1. Ensure you have Python available.
-2. Ensure `pip <https://pip.pypa.io/en/latest/installing.html>`__ is
-   installed.
 
 Installation
-^^^^^^^^^^^^
+============
 
-1. Install yaksh
+**Note**: Currently, only Linux and MacOS is supported for the project.
 
-   -  Clone the repository
+If Python 3.6 and above is not available in the system, then we recommend using
+miniconda. Download miniconda with Python 3.6 and above.
 
-      ::
+**Installing Miniconda**
 
-          $ git clone https://github.com/FOSSEE/online_test.git
+1. Download miniconda from https://docs.conda.io/en/latest/miniconda.html according to the OS version.
 
-   -  Go to the online\_test directory
+2. Follow the installation instructions as given in https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation
 
-      ::
+3. Restart the Terminal.
+
+**Pre-Requisite**
+
+* Ensure  `pip <https://pip.pypa.io/en/latest/installing.html>`_ is installed
+
+**Installing Yaksh**
+
+* **Clone the repository**
+
+  ::
 
-          $ cd ./online_test
+      git clone https://github.com/FOSSEE/online_test.git
 
-   -  Install the dependencies for local setup
+* **Go to the online_test directory**
 
-        ::
+  ::
 
-            $ pip install -r ./requirements/requirements-common.txt
+      cd online_test
 
-Short instructions
-^^^^^^^^^^^^^^^^^^
+* **Install the dependencies**:
+
+  * Install Django and dependencies
+
+    ::
+
+        pip3 install -r requirements/requirements-common.txt
+
+  * Install Code Server dependencies
+
+    ::
+
+        sudo pip3 install -r requirements/requirements-codeserver.txt
+
+
+Quick Start
+^^^^^^^^^^^
 
 1. Start up the code server that executes the user code safely:
 
diff --git a/README_production.rst b/README_production.rst
index 1126c41..b29fa4f 100644
--- a/README_production.rst
+++ b/README_production.rst
@@ -5,6 +5,15 @@ This README provides documentation to help deploy Yaksh in a production
 environment. If you wish to take Yaksh on a trial run, here is a
 `Quickstart Guide <https://github.com/FOSSEE/online\_test/blob/master/README.rst>`__
 
+
+Requirements
+============
+
+Python 3.6, 3.7, 3.8
+
+Django 3.0.3
+
+
 ###################
 Deploying Locally
 ###################
@@ -50,16 +59,26 @@ To install this app follow the steps below:
 
    ::
 
-      $ git clone  https://github.com/FOSSEE/online_test.git
-      $ cd online_test
+      git clone  https://github.com/FOSSEE/online_test.git
+
+   ::
+
+      cd online_test
 
 2. Install Yaksh dependencies, Run
 
    ::
 
-      pip install -r requirements/requirements-py2.txt # For Python 2
+      pip3 install -r requirements/requirements-common.txt
+
+   ::
+
+      pip3 install -r requirements/requirements-py3.txt
+
+   ::
+
+      sudo pip3 install -r requirements/requirements-codeserver.txt
 
-      pip3 install -r requirements/requirements-py3.txt # For Python 3
 
 3. Rename the ``.sampleenv`` to ``.env``
 
@@ -85,9 +104,6 @@ To install this app follow the steps below:
 
    ::
 
-        $ sudo python -m yaksh.code_server # For Python 2.x
-
-
         $ sudo python3 -m yaksh.code_server # For Python 3.x
 
     Put this in the background once it has started since this will not