Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aureliony authored Feb 18, 2024
1 parent 89d0d55 commit a9deec1
Showing 1 changed file with 34 additions and 24 deletions.
58 changes: 34 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,34 @@
# Duke project template

This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.

## Setting up in Intellij

Prerequisites: JDK 11, update Intellij to the most recent version.

1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
1. Open the project into Intellij as follows:
1. Click `Open`.
1. Select the project directory, and click `OK`.
1. If there are any further prompts, accept the defaults.
1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
In the same dialog, set the **Project language level** field to the `SDK default` option.
3. After that, locate the `src/main/java/Duke.java` file, right-click it, and choose `Run Duke.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
```
Hello from
____ _
| _ \ _ _| | _____
| | | | | | | |/ / _ \
| |_| | |_| | < __/
|____/ \__,_|_|\_\___|
```
# ConvoBot
> "Don't be afraid to give up the good to go for the great." — John D. Rockefeller ([source](https://www.goodreads.com/quotes/257630-don-t-be-afraid-to-give-up-the-good-to-go))
ConvoBot elevates your task management to the next level.

* text-based
* easy to learn
* ~FAST~ _SUPER FAST_ to use

All you need to do is,

1. download it from [here](https://github.com/aureliony/ip/releases).
2. run it.
3. add your tasks.
4. let it manage your task for you 😉

And it is **FREE**!

Features:

* [x] Manage todos
* [x] Manage deadlines
* [x] Manage events
* [ ] Manage reminders
* [x] Graphical UI
* [ ] Cloud storage

It is written in Java. Here's the `main` method:

```java
public static void main(String[] args) {
Application.launch(Main.class, args);
}
```

0 comments on commit a9deec1

Please sign in to comment.