Kyro

Kyro is a scheduler and chatbot designed to assist you in your daily life.

Its name is inspired by the Greek word Kyros, meaning "master". Given below are instructions on how to use it.

Quick Start

1. Ensure you have Java 17 installed on your computer.
2. Download the latest .jar file from Releases.
3. As the program creates save files in the same folder, you are recommended to create a separate directory for Kyro.
4. Run the program using the command java -jar <release-name>.jar

Setting up in Intellij

Prerequisites: JDK 17, 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)
2. Open the project into Intellij as follows:
   1. Click Open.
   2. Select the project directory, and click OK.
   3. If there are any further prompts, accept the defaults.
3. Configure the project to use JDK 17 (not other versions) as explained in here.
   In the same dialog, set the Project language level field to the SDK default option.
4. After that, locate the src/main/java/kyro/base/Kyro.java file, right-click it, and choose Run Kyro.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 ************************
    ____  __.                      
   |    |/ _|___.__._______  ____  
   |      < <   |  |\_  __ \/  _ \
   |    |  \ \___  | |  | \(  <_> )
   |____|__ \/ ____| |__|   \____/
           \/\/
   ____________________________________________________________                 
   

Warning: Keep the src\main\java folder as the root folder for Java files (i.e., don't rename those folders or move Java files to another folder outside of this folder path), as this is the default location some tools (e.g., Gradle) expect to find Java files.

Commands

************************* COMMANDS *************************
todo <description>                                                --> Add a todo Task
deadline <description> /by <yyyy-MM-dd HHmm>                      --> Add a deadline Task
event <description> /from <yyyy-MM-dd HHmm> /to <yyyy-MM-dd HHmm> --> Add an event Task
list                                                              --> List out all tasks
mark <task number>                                                --> Mark task by number
unmark <task number>                                              --> Unmark task by number
delete <task number>                                              --> Delete task by number
filter <yyyy-MM-dd>                                               --> Filter by date
find <keyword>                                                    --> Find by keyword
help                                                              --> Show this help message
bye                                                               --> End Session