docs: updated documentation

.github/Contributor_Guide/Contributing.md

@@ -1,12 +1,12 @@
-# Contribute to <Project_Name>
+# Contribute to Weather_Forecast-App
 
-Thank you for taking the time to contribute to <project_name>! We really appreciate it. 
+Thank you for taking the time to contribute to Weather_Forecast-App! We really appreciate it. 
 
 Before contributing, please make sure to read the [Code of Conduct](../../CODE_OF_CONDUCT.md). We expect you to follow it in all your interactions with the project.
 
-## New to <Project_Name>?
+## New to Weather_Forecast-App?
 
-If you are new to <Project_Name>, please take a look at the [documentation](./Project_Tour.md). It is a great place to start.
+If you are new to Weather_Forecast-App, please take a look at the [documentation](./Project_Tour.md). It is a great place to start.
 
 ## New Contributor Guide
 
@@ -22,13 +22,13 @@ If you find a bug in the source code, you can help us by [submitting an issue](.
 
 ### Suggesting Enhancements
 
-If you want to suggest an enhancement to <Project_Name>, please [submit an issue](../ISSUE_TEMPLATE/feature_request.yaml).
+If you want to suggest an enhancement to Weather_Forecast-App, please [submit an issue](../ISSUE_TEMPLATE/feature_request.yaml).
 
 ### Pull Requests
 
-If you want to contribute to <Project_Name>, submit a pull request.
+If you want to contribute to Weather_Forecast-App, submit a pull request.
 
-- url: `https://github.com/OPCODE-Open-Spring-Fest/<project_Name>/compare/branch...YOURGITHUBUSERNAME:<project_Name>:BRANCH?quick_pull=1&template=pr.md`
+- url: `https://github.com/OPCODE-Open-Spring-Fest/weather_forecast-App/compare/branch...YOURGITHUBUSERNAME:weather_forecast-App:BRANCH?quick_pull=1&template=pr.md`
 
 ### Requirements
 

.github/Contributor_Guide/Project_Tour.md

@@ -1,12 +1,35 @@
 # Project Tour
 
-* notes:
-*  > Discuss about your project file structure
-*  > what each folder is responsible
-*  > then go through each file in folders and explain there purpose
-*  > if possible create a doc system ( there are autogen docs available for most of the languages )
-*  > decide coding style , linting style and formatting style and other themes like variable naming etc.
-*  > provide an example for existing function and tests system if possible 
-*  
-
-# MAKE SURE PROJECT MANAGERS UPDATE THIS MD 
+## Folder Structure
+Folders:
+* .github
+    * Contributor_Guide
+        * Contributing.md:- Contributing guidlines.
+        * Project_Tour.md:- Details of project.
+        * commiting.md:- Commiting Guidelines
+    * ISSUE_TEMPLATE
+        * bug_report.yaml:- Template to raise a bug isssue.
+        * feature_request.yaml:- Template to raise a bug isssue.
+    * PULL_REQUEST_TEMPLATE
+        * pr.md:- Template of pull request.
+* .husky:- For project managers.
+* android
+* assetes:- contains images, icons, animation ets.
+* ios
+* lib
+    * pages:- Contains source code of different screen.
+    * main.dart
+* linux
+* macos
+* test 
+* web
+* windows
+Files:
+* .gitignore
+* CODE_OF_CONDUCT.md
+* README.md
+* analysis_options.yaml
+* commitlint.config.js
+* package-lock.json
+* package.json
+* pubspec.yaml

README.md

@@ -1,16 +1,65 @@
-# weather_app
+# Weather Forecast App
 
-A new Flutter project.
+## Introduction ✨
 
-## Getting Started
+Weather forecast application provides real-time updates through OpenWeather API, utilizing a location detection plugin for accurate weather display based on device location.
 
-This project is a starting point for a Flutter application.
 
-A few resources to get you started if this is your first Flutter project:
+## Technologies Used 🧑‍💻
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+* Flutter
+* Open WeatherAPI
+* Location Pligin
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+
+
+## Contact 📱
+
+If you have any questions or feedback, please reach out to us at [email protected]. 📧
+
+
+
+### Setup
+
+To set up **code-a-licious** on your local machine, follow these steps:
+
+
+
+1. Fork the repository:
+   - Click the "Fork" button at the top right corner of this repository's page on GitHub. This will create a copy of the repository in your GitHub account.
+
+2. Clone the forked repository:
+
+```bash
+git clone https://github.com/<yourusername>/todoapp.git
+```
+
+3. Navigate to the project directory:
+```bash
+cd todoapp
+```
+
+
+4. Install Node.js dependencies(make sure node is installed on your laptop):
+```bash
+npm i
+```
+5.  Create a new branch for your feature or bug fix.
+
+6. Install dependencies:
+
+    ```bash
+    flutter pub get
+    ```
+
+7. Run the application:
+
+    ```bash
+    flutter run
+    ```
+
+8. Make your changes and commit them.
+9. Push to the branch.
+10. Submit a pull request.
+
+You are good to go to make your contribution!! All the best.