Added FLINT Handbook Github Link Issue #2 (#18)

* Update README.md Updated * Update README.md Updated Signed-off-by: meenaljain0303 <[email protected]> * new files added Signed-off-by: meenaljain0303 <[email protected]> * new * added the link * dummy changes added Signed-off-by: meenaljain0303 <[email protected]> * new changes added Signed-off-by: meenaljain0303 <[email protected]> --------- Signed-off-by: meenaljain0303 <[email protected]>
moja-global · Mar 11, 2023 · 499a846 · 499a846
1 parent 78902df
commit 499a846
Showing 1 changed file with 15 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,15 @@
 # Handbook
+## Introduction 
+[FLINT Handbook](https://moja-global.github.io/Handbook/) is intended to provide an introduction to FLINT so that its readers, regardless of their knowledge level can understand what FLINT aims to accomplish. The FLINT handbook will go over climate science, the problems it poses to our environment, and the steps we can take to mitigate it's effects.
 
-This repository contains FLINT Handbook
+The Handbook covers:
+
+- Understanding Climate Science and Organizations championing the cause.
+- Use of carbon models like the Generic Carbon Budget Model (GCBM).
+- Introduction to Full Lands and Integration tools.
+- Role of Data Version Control (DVC) in Land Sector Dataset Repos.
+- Running a GCBM Silmulation.
+- Discussion on Climate Science and Projections.
 
 ## Installation
 
@@ -14,9 +23,11 @@ Here are the steps you can follow while setting up the documentation locally.
 
 If you choose to setup the documentation website locally, you need to have Python and the Python package manager `pip` on your local machine. Follow the official [Python installation](https://www.python.org/downloads/) to setup Python on your local machine.
 
-First make a fork, and then clone the repo:
+First make a fork, and then clone the repo
+
+2. Clone the repository 
 
-2. Clone the repository. Replace the `<GITHUB_USERNAME>` with your GitHub username. You can find your username by clicking on your profile picture in the top right corner of the GitHub website.
+Replace the `<GITHUB_USERNAME>` with your GitHub username. You can find your username by clicking on your profile picture in the top right corner of the GitHub website.
 
 ```sh
 git clone https://github.com/<GITHUB_USERNAME>/Handbook
@@ -42,4 +53,4 @@ pip install -r requirements.txt
 make html
 ```
 
-You can now open the Handbook website on `_build/html/index.html` in your browser. Make corresponding changes on the documentation site and then run `make clean && make html` to update the documentation. You can now create a pull request to get your changes merged into the upstream develop branch.
+You can now open the Handbook website on `_build/html/index.html` in your browser. Make corresponding changes on the documentation site and then run `make clean && make html` to update the documentation. You can now create a pull request to get your changes merged into the upstream develop branch.