Skip to content

chenxy12345/ip

 
 

Repository files navigation

Elmacho - Tasklist Assistant User Guide

This is Elmacho! A personal tasklist assistant that records all your tasks. seaOtter.png

"What. I'm Elmacho. What you want?" — Elmacho

Here are the types of Tasks available:

💡 📝 📝

  • ToDo
  • Deadline
  • Event

To create Tasks, run:

ToDo 📋

Format: todo {task description}
eg. todo fold clothes

Deadline 📅

Format: deadline {task decription} /by {yyyy-MM-dd HHmm}
eg. deadline tutorial 4 /by 2025-02-16 2359

Event 🗓️

Format: event {task description} /from {yyyy-MM-dd HHmm} /to {yyyy-MM-dd HHmm}
eg. event club cohesion /from 2025-02-20 1500 /to 2025-02-20 2200

If tasks are successfully stored, the output will be as follows:

Added Task: 
  [T][ ] fold clothes 
Now you have 1 tasks in the list.
Added Task:
  [D][ ] tutorial 4 (By: Feb 16 2025 11:59pm)
Now you have 2 tasks in the list.
Added Task:
  [E][ ] club cohesion (From: Feb 20 2025 3:00pm To: Feb 20 2025 10:00pm)
Now you have 3 tasks in the list.

Features:

Deleting a task :delete

Format: delete {task number} eg. delete 1

Deleted Task: 
  [T][ ] fold clothes 
Now you have 2 tasks in the list.

Marking a task complete: mark

Format: mark {task number} eg. mark 1

Finally. Marked this task as done: 
  [X] fold clothes 

Unmarking a task: unmark

Format: unmark {task number} eg. unmark 1

Another task not done...: 
  [ ] tutorial 4

Archiving a task: archive

Format: archive {task number} eg. archive 2

Archived task: 
  [T][ ] tutorial 4
Now you have 1 tasks in the archived list,
2 tasks in the list.

Unarchiving a task: unarchive

Format: unarchive {task number} eg. unarchive 1

Unarchived task: 
  [T][ ] tutorial 4
Now you have 3 tasks in the list.

Finding tasks through keywords: find

find {keyword} eg. find tutorial

2.[D][ ] tutorial 4 (By: Feb 16 2025 11:59pm)

Displaying full tasklist: list

Format: list eg. list

Your never ending list:

1.[T][X] fold clothes 
2.[D][ ] tutorial 4 (By: Feb 16 2025 11:59pm)
3.[E][ ] club cohesion (From: Feb 20 2025 3:00pm To: Feb 20 2025 10:00pm)

Displaying archived tasklist: archive list

Format: archive list eg. archive list

You avoiding your problems by archiving tasks:

1.[T][ ] tidy room
2.[D][ ] tutorial 1 (By: Feb 20 2025 11:59pm)

Viewing help: help

Format: help
List of features and formats will appear

Exiting the program: bye

Format: bye
Elmacho exits

Caution

Only delete when you're sure you've finished the task!
Archive if you may still go back to it.

Starting Elmacho

  1. Ensure the right java version is installed.

    java -version

  2. Download the .jar file.

    • Alternatively, clone the Github Repository.

    git clone https://github.com/chenxy12345/ip

  3. Navigate to the Directory the file is in.

    cd /path/to/your/jar/file

  4. Run the .jar file.

    java -jar elmacho.jar

    A GUI similar to below should appear in a few seconds. Welcome.png

  5. Type the command in the command box and press Send to execute it.

To view the github repository: click here

Do comment any feedback/improvement! 😄

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Java 93.1%
  • CSS 3.6%
  • Shell 1.9%
  • Batchfile 1.4%