Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.59 KB

R14.installation.md

File metadata and controls

55 lines (41 loc) · 2.59 KB

CSC 493: R14: Installation and Use1

Overview

You should be finishing up the main implementation details of your project. Some of you will have clear installation instructions in order to be able to run your project, and others will have specific ideas of how to get your mobile app onto the phone.

Documentation

You have some tasks to complete before next time:

  • Create a installation document in a file called installation.md.
  • Update README.md to link to the file you just created.
  • Continue implementing pieces of your project (this assignment will be accompanied by another one on how to create issues on GitHub and linked them to commits and pulls.

installation.md Write a guide that steps a typical user through how to install your software. In your final video, you will be demoing the installation, so here do not use a video. Instead, show the installation in a typical case in writing. Screen shots are likely to be very useful here.

Next, detail in writing a few of the typical use cases of your software. Screen shots are likely to be helpful here too. Be sure to highlight the features that work well rather on dwelling on features that you wish you had time to implement in this prototype.

README.md

You should update the README.md file with a link to your Test Plan.

  • Project name
  • Project Concept (linked to concept.md)
  • Vision
    The paragraph of your vision is here.
  • Scope
    The paragraph of your scope is here.
  • Prerequisites
  • Requirements (linked to requirements.md)
  • Design (linked to design.md)
  • Test Plan (linked to test.plan.md)
  • Built With
  • Author name
    • About the Lead Developer Your biographical information
  • Acknowledgments
  • Installation and use guide (linked to install.md)

More Software development

Fully implement another small portion(s) of your project. As always, it is required that you thoroughly comment this component so that you can refer to it later to know what you were working on.

Be sure to highlight what you have accomplished and where you are stuck in your Scrum report.

To Submit

  • Commit your updated code to Github.
  • Complete Installation and Use Guide on installation.md and link from your README.md file.

1. Adapted from https://raw.githubusercontent.com/pearcej/pearcej.github.io/master/csc493/r12-install.md