- Set up a product website
- Submit the final version Mon, Sep 28th 2359
1 Set up a product website
- Add a brief User Guide (UG)
Duke
A-UserGuide: User Guide Add a User Guide to the project. Here is one simple way to do it.
- Update the given
docs\README.md. See this guide to GitHub flavored Markdown (GFMD). - Go to the settings page of your Duke fork and enable GitHub pages to publish from the
docsfolder (you can select a theme too). - Go to
http://{your username}.github.io/{repo name}/to view the user guide of your product. Note: it could take 5-10 minutes for GitHub to update the page.
2 Submit the final version Mon, Sep 28th 2359
- Create a new jar file
- Create the JAR file in one of these ways:
- If you have added a GUI or using third-party libraries: use Gradle.
- Else: you can use Intellij.
- The JAR file should be cross-platform and should work in a computer that has Java 11.
- Create the JAR file in one of these ways:
- Do the following smoke tests to ensure the jar file works (reason: a similar flow will be used when grading your iP).
- Copy the jar file to an empty folder and test it from there. This should surface issues with hard-coded file paths.
- Pass the jar file to team members and ask them to do a test drive. Assuming some of your team members' OS differ from yours, this should verify if the app is cross-platform.
- Create a new release on GitHub (e.g.,
v0.2) and upload the JAR file.- Recommended to refrain from uploading multiple JAR files as this can cause extra work for the evaluators.