search

Team4019 / team4019-2017

Mechanical Paradise's GitHub repository for the code we wrote for our robot.
0 stars 1 forks source link

Project Team needs Environment Build Instructions (DEV and QA) #4

Closed torpedo51 closed 7 years ago

torpedo51 commented 7 years ago

I'd like Cameron to produce an Installation Manual (PDF or HTML format) and attach it either to the Wiki or place it inside of the /artifacts folder.

Cameron, please work with Cooper to get all of the details. When you're finished, Cameron will help each developer walk through the procedure to get set up and running. The Manual should include these sections:

Software Requirements

Procedure to download (clone) the GitHub repository to a local environment

  1. Create a local folder to store the code (e.g. \users\tim\Team4019-2017
  2. Start GitKraken
  3. Select "Clone Repository"
  4. Provide these values to the clone wizard: ... ... ...
  5. etc.

Environment Verification

  1. From a command line, do this: $> and expect this result (e.g. "version 1.2")
  2. etc.

Basic Check-out and Check-in procedure (provide a harmless example that we can actually do)

  1. Pull the repository to make sure you have all of the latest code
  2. Make a change to the readme.txt file (add your name to the top)
  3. Check-in your change
  4. verify the change by looking at the file on the Online (not local) GItHub repository
cooperuser commented 7 years ago

Pushed the new version of the repo with an updated README.md. It gives instructions on how to get everything set up and ready to go.

torpedo51 commented 7 years ago

Cooper, These instructions need more granularity. For example, we don't know how to open the repository (there are options), select a branch (which branch do we want on our locals to start with), set the local folder for GitKraken, and which pull option to use (there are a few). Can you and Cameron have another pass at this please? Thanks

torpedo51 commented 7 years ago

invalid references error