From 4944df7ce5be72ea5f9131866ab0482ffdca2bc5 Mon Sep 17 00:00:00 2001 From: brutzman <brutzman@nps.edu> Date: Tue, 24 Jul 2018 17:19:15 -0700 Subject: [PATCH] initial README for all projects --- deliverables/README.md | 45 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 deliverables/README.md diff --git a/deliverables/README.md b/deliverables/README.md new file mode 100644 index 0000000000..9c887afc4d --- /dev/null +++ b/deliverables/README.md @@ -0,0 +1,45 @@ +# Using Netbeans for MV3500 Deliverables + +## Initialization and Refresh + +To submit homework via Netbeans to the gitlab server you will first need to +clone a copy of the course repository at + +* https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500 + +Use Netbeans to upload/update your homework assignments as follows: + +1. *context menu:* **Git > Remote > Pull from Upstream** to first always ensure you update your repository +1. Save into your local directory for `projects/Assignments/COURSE_IDENTIFIER/homework1` (as appropriate) + * For example 2018JanuaryMarch or 2018JulySeptember +1. Select file of interest in Netbeans tab for Files +1. *context menu:* **Refactor/Rename** and take spaces out of file name (gets wacky on various operating systems, email etc.) +1. Ensure Java classes and source files start with your last name +1. *context menu:* **Run file**(s) to test +1. *context menu:* **Git > commit**; provide comment documenting the change +1. Verify that the entry in Files tab goes from green to black, indicating you have committed to your local repository. +1. *context menu:* **Git > Remote > Push to Upstream** + +You can now verify that your files are been shared by checking the website: + +* https://gitlab.nps.edu/Savage/NetworkedGraphicsMV3500/tree/master/projects/Assignments/ +* then append `COURSE_IDENTIFIER` YearStartEnd (i.e. *2018JanuaryMarch*, *2018JulySeptember*, etc.) + +## Adding Your Files + +All MV3500 cohorts have source code collected under a common Netbeans project. + +1. You can look at prior cohort submissions, for example [MV3500Cohort2018JanuaryMarch](src/MV3500Cohort2018JanuaryMarch) +2. Find your current cohort subdirectories, for example [MV3500Cohort2018JulySeptember](src/MV3500Cohort2018JulySeptember) +3. Locate the correct subdirectory, for example **homework1** **homework2** etc. +4. Name each of your files starting with your last name, e.g. **BrutzmanProgram.java** **BrutzmanScreenshot.png** etc. +5. Be sure that names match for **BrutzmanProgram.java** and the class name, i.e. **public class BrutzmanJava** +6. Be sure to start each .java source file with correct package name, i.e. + * import MV3500Cohort2018JulySeptember.homework +7. The Run and Debug context menus should be available for you to test your .java source. + +## References + +* [Netbeans 8](http://www.netbeans.org) and [Using Git Support](https://netbeans.org/kb/docs/ide/git.html) with [tutorial video](https://netbeans.org/kb/docs/ide/github_nb_screencast.html) +* [GitLab Flavored Markdown (GFM)](https://docs.gitlab.com/ee/user/markdown.html) and [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) +* UML [Sequence diagram](https://en.wikipedia.org/wiki/Sequence_diagram) on Wikipedia -- GitLab