search

Evans20kom / Console-Finances

A Javascript console application that will produce output from the contents of two arrays. The challenge for week 4 of the bootcamp.
MIT License
0 stars 0 forks source link

README #1

Closed Evans20kom closed 8 months ago

Evans20kom commented 8 months ago

README

Finalize Readme file before deployment

Feedback from previous assignment:

Areas for Improvement: Your repository's README is missing some essential elements, specifically a description, screenshots of the deployed application (not just links to screenshots), and a link to the deployed application. These are crucial components that help visitors quickly understand the purpose of your project, visualize its functionality, and access the live version. Suggestions: Please ensure to include a comprehensive README that covers all necessary information. A clear description, screenshots, and a link to the deployed application will greatly enhance the README's value. Additionally, consider adding clickable links in your portfolio to take users directly to your project repository or the deployed project. This can further streamline the user experience and make it easier for visitors to explore your work.

Actions to take:

  1. Do the following for current README:
    • Improve description of the application
    • add screenshots within the readme file
    • add link to deployed website within the readme file
    • add link to repository
  2. Check previous README. Were elements missing indeed? If Not, was their placement counterintuitive?
  3. Create a comprehensive README template to reuse

Structure:

Description

Provide a short description explaining the what, why, and how of your project. Use the following questions as a guide:

Installation

What are the steps required to install your project? Provide a step-by-step description of how to get the development environment running.

Usage

Provide instructions and examples for use. Include screenshots as needed.

To add a screenshot, create an assets/images folder in your repository and upload your screenshot to it. Then, using the relative filepath, add it to your README using the following syntax:

```md
![alt text](assets/images/screenshot.png)
```

Credits

List your collaborators, if any, with links to their GitHub profiles.

If you used any third-party assets that require attribution, list the creators with links to their primary web presence in this section.

If you followed tutorials, include links to those here as well.

License

The last section of a high-quality README file is the license. This lets other developers know what they can and cannot do with your project. If you need help choosing a license, refer to https://choosealicense.com/.

🏆 The previous sections are the bare minimum, and your project will ultimately determine the content of this document. You might also want to consider adding the following sections.

Badges

badmath

Badges aren't necessary, per se, but they demonstrate street cred. Badges let other developers know that you know what you're doing. Check out the badges hosted by shields.io. You may not understand what they all represent now, but you will in time.

Features

If your project has a lot of features, list them here.

Evans20kom commented 8 months ago

Issue with previous project's README file

Bug in markdown media tag prevents screenshots from presenting properly within README file and preview of elements from first media tag onwards.

  1. Correct for this project
  2. Test - include in tests (?)
  3. Save template for future projects
Evans20kom commented 8 months ago

README file FInished

FInal version uploaded to deployed application; README includes actions towards addressing feedback from previous assessment.