From 4c1e28abd9c966d680a2e6da8fc7673236179cdf Mon Sep 17 00:00:00 2001 From: Gallen <90502827+gongg21@users.noreply.github.com> Date: Mon, 13 Nov 2023 22:43:19 +0800 Subject: [PATCH] Update DG files --- docs/DeveloperGuide.md | 3 ++- docs/Documentation.md | 2 -- docs/SettingUp.md | 18 ++++++++---------- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 3cf96d46a40..4eaf7a3469a 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -10,7 +10,8 @@ ## **Acknowledgements** -* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} +* [AB-3](https://nus-cs2103-ay2324s1.github.io/tp/) +* [Waddle](https://ay2223s1-cs2103t-w11-4.github.io/tp/) -------------------------------------------------------------------------------------------------------------------- diff --git a/docs/Documentation.md b/docs/Documentation.md index 4ef07404358..3b94812ff3a 100644 --- a/docs/Documentation.md +++ b/docs/Documentation.md @@ -4,8 +4,6 @@ pageNav: 3 --- -# Documentation Guide - * We use [**Jekyll**](https://jekyllrb.com) to manage documentation. * The `docs/` folder contains the source files for the documentation website. * To learn how set it up and maintain the project website, follow the guide [[se-edu/guides] Working with Forked Jekyll sites](https://se-education.org/guides/tutorials/jekyll.html#:~:text=the%20final%20outcome.-,Site%2Dwide%20settings,-Typically%2C%20the%20_config) for project documentation. diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 076e8a89ee8..4e913d2a3bb 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -4,26 +4,24 @@ pageNav: 3 --- - - ## Setting up the project in your computer -
+
-**Caution:** +:exclamation: **Caution:** Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps. - +
First, **fork** this repo, and **clone** the fork into your computer. If you plan to use Intellij IDEA (highly recommended): 1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to to ensure Intellij is configured to use **JDK 11**. 2. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA. - - + +
Note: Importing a Gradle project is slightly different from importing a normal Java project. - +
3. **Verify the setup**: 1. Run the `seedu.codesphere.Main` and try a few commands. @@ -37,10 +35,10 @@ If you plan to use Intellij IDEA (highly recommended): If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match ours. - +
:bulb: **Tip:** Optionally, you can follow the guide [_[se-edu/guides] Using Checkstyle_](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use the CheckStyle within IDEA e.g., to report problems _as_ you write code. - +
2. **Set up CI**