From 821e4fec8e4422d2ab7bec166b4a92e018c6c5b7 Mon Sep 17 00:00:00 2001
From: ashwinpra <ashprasanth2003@gmail.com>
Date: Thu, 27 Jul 2023 00:17:53 +0530
Subject: [PATCH] update docs

---
 README.md | 60 +++++++++++++++++++------------------------------------
 1 file changed, 20 insertions(+), 40 deletions(-)

diff --git a/README.md b/README.md
index 534bf48..e14a367 100644
--- a/README.md
+++ b/README.md
@@ -14,66 +14,46 @@ pip install -r requirements.txt
 ```
 ## Usage
 
-### 1. For breadth electives
-- First find the slots available for your elective:
-  - Go to Academic -> Time Table -> Central TimeTable 2023-2024 AUTUMN (year and session could vary)
-  - Go to the "COMMON SUBJECTS AND BREADTH SLOTS" section corresponding to your year, locate your department, and find the slots where `B` or `HSS` is mentioned
-<br></br>
-- Run the `find_breadths.py` script following the format: 
+- Run the `gyfe.py` script following the format: 
 ```sh
-python3 find_breadths.py --slots <list-of-slots>
+python3 gyfe.py <breadth/depth> --year <year-of-study> --session <session> --semester <semester>
 ```
+- The first argument is either `breadth` or `depth`, depending on which electives you want to find
+- `--year` is your year of study **(single digit)**, eg: `3`
+- `--session` is in the format `YYYY-YYY`, eg: `2023-2024`
+- `--semester` is either `AUTUMN` or `SPRING` 
+> **Note**
+> - `--session` has a default value of `2023-2024`, and `--semester`` has a default value of `SPRING`
+> - This must be changed every semester
 - Optional flag(s):
-  - `-o` or `--overwrite`: Overwrite the old `breadth_electives.csv` file
   - `--notp`: Don't use the `token.json` file to login, instead enter OTP manually (easier setup)
 <br></br>
-- This will generate a file called `breadth_electives.csv` with all the breadth electives, along with `available_breadths.txt`, which will list the breadth electives available to you (based on your slots)
+- This will generate either `available_breadths.txt` or `available_depths.txt` depending on the first argument
 
 
-#### Example(s)
+#### Example(s) 
 ```sh
-python3 find_breadths.py --slots F4 G3 
-# find breadth electives for slots F4 and G3 from pre-existing breadth_electives.csv file
+python3 gyfe.py depth --year 3 --session 2023-2024 --semester AUTUMN
+# find depth electives for 3rd year, Autumn 2023-2024, with automatic OTP fetching for login
 
-python3 find_breadths.py -o --slots F4 G3 
-# generate a new breadth_electives.csv with automatic OTP fetching for login and find breadth electives for slots F4 and G3 
+python3 gyfe.py depth --notp --year 3 --session 2023-2024 --semester AUTUMN
+# find depth electives for 3rd year, Autumn 2023-2024, with manual OTP input for login
 
-python3 find_breadths.py -o --notp --slots F4 G3 
-# generate a new breadth_electives.csv with manual OTP input for login and find breadth electives for slots F4 and G3 
+python3 gyfe.py breadth --year 3 --session 2023-2024 --semester AUTUMN
+# find breadth electives for 3rd year, Autumn 2023-2024, with automatic OTP fetching for login
 
+python3 gyfe.py breadth --notp --year 3 --session 2023-2024 --semester AUTUMN
+# find breadth electives for 3rd year, Autumn 2023-2024, with manual OTP input for login
 ```
 - Example `available-breadths.txt`:
 <img src="./sample_breadths.png">
 
----
-
-### 2. For depth electives
-- Run the `find_depths.py` script following the format: 
-```sh
-python3 find_depths.py --dept <department-code> --year <year-of-study> --session <session> --semester <semester>
-```
-- `--dept` is the **2-letter code** of your department, eg: `CS`, `MA`, `IM`, etc.
-- `--year` is your year of study **(single digit)**, eg: `3`
-- `--session` is in the format `YYYY-YYY`, eg: `2023-2024`
-- `--semester` is either `AUTUMN` or `SPRING` 
-- Optional flag(s):
-  - `--notp`: Don't use the `token.json` file to login, instead enter OTP manually (easier setup)
-
-#### Example(s) 
-```sh
-python3 find_depths.py --dept CS --year 3 --session 2023-2024 --semester AUTUMN
-# find depth electives for CS 3rd year, Autumn 2023-2024, with automatic OTP fetching for login
-
-python3 find_depths.py --notp --dept CS --year 3 --session 2023-2024 --semester AUTUMN
-# find depth electives for CS 3rd year, Autumn 2023-2024, with manual OTP input for login
-```
-
 - Example `available-depths.txt`:
 <img src="./sample_depths.png">
 
 --- 
 
 ### Future plans
-- Automate the fetching of breadth slots
+- See how your timetable will look like with the electives you choose (OR somehow merge this with [what-slot](https://github.com/met-kgp/what-slot))
 - Make it a web app for ease of use