Skip to content

Commit

Permalink
Update DG files
Browse files Browse the repository at this point in the history
  • Loading branch information
gongg21 committed Nov 13, 2023
1 parent f602257 commit 4c1e28a
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 13 deletions.
3 changes: 2 additions & 1 deletion docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

--------------------------------------------------------------------------------------------------------------------

Expand Down
2 changes: 0 additions & 2 deletions docs/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
18 changes: 8 additions & 10 deletions docs/SettingUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,24 @@
pageNav: 3
---

<!-- -------------------------------------------------------------------------------------------------------------------- -->

## Setting up the project in your computer

<div type="warning" seamless>
<div markdown="span" class="alert alert-warning">

**Caution:**
:exclamation: **Caution:**
Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps.
</box>
</div>

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.
<box type="warning" seamless>

<div markdown="block" class="alert alert-info">

Note: Importing a Gradle project is slightly different from importing a normal Java project.
</box>
</div>

3. **Verify the setup**:
1. Run the `seedu.codesphere.Main` and try a few commands.
Expand All @@ -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.

<box markdown="span" class="alert alert-primary">
<div markdown="block" class="alert alert-info">

: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.
</box>
</div>

2. **Set up CI**

Expand Down

0 comments on commit 4c1e28a

Please sign in to comment.