caffeineaholics / caffeineaholics/Login

Add content to README

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
C++
Stars
0
Forks
11
PR merge metrics
No merged PRs in 30d

Description

The readme file is empty and we want to add how tos to it. We would like to make it look better by adding sections like :-

- About the project

- How to compile and run the project

- Contributing guidelines (How-to)
More sections can be added as per the discussion below. Comment to let us know you're working on it.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the project files and existing build or run instructions, then create the README with sections for the project overview, compilation and execution, and contributing guidelines. Done means the README is no longer empty, the requested sections are present, and the instructions accurately describe how to compile and run the C++ project.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.