MetroCS / imagelab

ImageLab
GNU General Public License v3.0
7 stars 80 forks source link

[UserStory] ReadMe updates from a User perspective. #117

Open elmattes opened 1 year ago

elmattes commented 1 year ago

User Story

Essential components

Story

As a user I want I want my landing on the GitHub repository page with README displayed to tell me how to get and use the product so that I can use the product and do so appropriately.

Acceptance Criteria

Change ReadMe to give it more clarity for brand new and returning users to utilize and run the project. Specific changes for the user:

  1. The project website, along with introductory text, appears at the top of ReadMe after the project overview.
  2. BlueJ user instructions appear in the user-oriented website page
  3. Command line user instructions no longer appear in the repository-level README. (The text surrounding the webpage link at the top of the page provides adequate context to make it clear that information appears on the webpage.)

Supporting Information

All user-relevant information should appear on the project's "website" page.

Dependencies

Dependents

113