Geeky-Sam01 / Geeky-Sam01/saferoute_final

Create a Readme.md & documentation of how to run the app locally.

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
Python
Stars
0
Forks
3
PR merge metrics
No merged PRs in 30d

Description

| Heading | Content |
|--------|--------|
| Project Overview | Write about what this project does , copy from prev. |
| Features | Write about features of this project divide into priority features and good to have |
| How to run | Well documented instructions on how to run this project locally , copy from previous and discuss with @Geeky-Sam01 |
| Authors | Write a list of authors of this project along with respective github profiles |
| Research papers | Add all the research papers referenced |
| Datasets | add dataset links |
| System Design | Not urgent |

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the repository and any previous documentation referenced in the issue, then discuss the local-run instructions with @Geeky-Sam01. Create README.md covering the project overview, prioritized features, local setup, authors and profiles, referenced research papers, and dataset links; system design is explicitly not urgent. Done means these sections and links are present and the local instructions are understandable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.