Finalize README - Githubissues

aj-govil / AppDevII-FocusApp

This tasking application manages your tasks in a unique way to improve productivity.

GNU General Public License v3.0

0 stars 0 forks source link

Finalize README #90

Closed michaelhaaf closed 9 months ago

michaelhaaf commented 10 months ago

title: Finalize README milestone: Milestone 4b Requirements label: documentation

Requirements

Your README, as the landing page of your application repository, must clearly express the purpose and behavior of your application. It doesn't have to be fancy, but there are great ways to improve its readability and relevance that you can follow in the resources below.

Priority

You can leave this task for last, but make sure it is done before the deadline.

Resources

Use relative links for screenshot images.
Ensure that there are developer instructions for:
- building the code using ./gradlew build
- testing the style with ./gradlew spotlessCheck
- the code using ./gradlew spotlessApply
Check out this template this template, they are good starting points that should mostly apply to your application.
(Aspirational, not necessary but good for inspiration) Check out this curated list of example READMEs.

Before completing this ticket:**

[ ] README content up to date
[ ] Tips from the resources above applied to your repo