aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuuta Liang <yuutaw@student.cs.ubc.ca>2023-11-29 16:21:46 -0800
committerYuuta Liang <yuutaw@student.cs.ubc.ca>2023-11-29 16:21:46 -0800
commitd8602eb255308fff4c6280936c577522f0bfc8ea (patch)
tree8731d55aab3859d7b1074f84d1b640056226b57b
parent878c3bdce6911451aa216c9a1691fa7dc066715d (diff)
downloadjca-d8602eb255308fff4c6280936c577522f0bfc8ea.tar
jca-d8602eb255308fff4c6280936c577522f0bfc8ea.tar.gz
jca-d8602eb255308fff4c6280936c577522f0bfc8ea.tar.bz2
jca-d8602eb255308fff4c6280936c577522f0bfc8ea.zip
Emphasize on other unrelated files in repository
Signed-off-by: Yuuta Liang <yuutaw@student.cs.ubc.ca>
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index a4e811e..aa85085 100644
--- a/README.md
+++ b/README.md
@@ -136,6 +136,28 @@ They do not subject to project requirements as they are not part of the project
local build tools. The project (both tests and UI) runs perfectly without any of these files. To run the project, clone it
in IntelliJ Idea and press the green triangle in `Main`.
+Again, these codes and build files are ONLY included in the repository for referencing purposes. THEY ARE NOT PART OF THE
+SUBMISSION.
+
+SPECIFICALLY, the files that are NOT part of the submission are the follows (**DO NOT GRADE**):
+
+* build.gradle (Gradle build file for my local testing of the project without IntelliJ Idea. This includes declerations for
+testing and the project, with coverage. It also includes the task to generate UMLs.)
+* settings.gradle (Multi-project Gradle build file.)
+* umlgen/ (The source code of my tiny UML generator. Written in Kotlin.)
+* tests/ (Used to generate external testing data for demonstration purposes. That is, this directory includes build scripts
+that use OpenSSL to simulate a root CA and leaf certificate holder. Written in Makefile.)
+
+**!!! PLEASE DO NOT GRADE ANY PART INCLUDED IN THE ABOVE LIST !!!**
+
+The files that ARE part of the submission are the follows (**PLEASE GRADE**):
+
+* checkstyle.xml (The original checkstyle configuration file, as provided with the starter.)
+* data/ (Data used in testing. Also used to store the `ca.json` used in load / store functionalities.)
+* src/ (Main and test Java source files, including PNG resources.)
+* lib/ (JAR libraries, including both JUnit libraries provided with the starter and external libraries imported during development phases.)
+* img/ (UML PDFs.)
+
## Author
Yuuta Liang <yuutaw@student.ubc.ca>