Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📃 add documentation #7

Merged
merged 1 commit into from
Feb 11, 2023
Merged

📃 add documentation #7

merged 1 commit into from
Feb 11, 2023

Conversation

diragb
Copy link
Member

@diragb diragb commented Feb 8, 2023 •
edited by Sharan420
Loading

IMPLEMENTS #6

Description

The codebase lacks steps for installation and general practices, along with a codebase map.

Acceptance Criteria

  • Add a README.md to the root of the project, with:
    • Steps for setup
    • Steps for running the application (on a physical device and on an emulator)
    • Guidelines for development
    • Map of the codebase

Notes

Map of the codebase deemed not important as code is sufficiently self-documenting.

@diragb diragb added this to the Functional MVP 🚀 milestone Feb 8, 2023
@diragb diragb added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 8, 2023
@diragb diragb self-assigned this Feb 8, 2023
@diragb diragb requested a review from Sharan420 February 8, 2023 16:48
Sharan420
Sharan420 approved these changes Feb 10, 2023
View reviewed changes
Copy link
Collaborator

@Sharan420 Sharan420 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep went through the README
OCD levels of organisation
love it

@diragb diragb merged commit 6544bb4 into master Feb 11, 2023
@diragb diragb deleted the README branch February 11, 2023 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Sharan420 Sharan420 Sharan420 approved these changes

Assignees

@diragb diragb

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
Functional MVP 🚀
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@diragb @Sharan420