Skip to content

Commit

Permalink
Merge branch 'develop' of https://github.com/noisrucer/girok into dev…
Browse files Browse the repository at this point in the history
…elop
  • Loading branch information
noisrucer committed Mar 24, 2023
2 parents 8357247 + 57fa4d4 commit 77f9e2f
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,24 @@ Girok is running on AWS server so you can **login from any device in the world**

- [🚀 Installation](#-Installation)
- [🔥 Get Started](#-get-started)
- [1. help command](#help-command)
- [1. help command](#helpcommand)
- [2. Register](#register)
- [3. Login / Logout](#login-and-logout)
- [4. Category commands](#category-commands)
- [4.1 `showcat`](#showcat-command)
- [4.2 `addcat`](#addcat-command)
- [4.3 `mvcat`](#mvcat-command)
- [4.4 `rmcat`](#rmcat-command)
- [4.5 `rncat`](#rncat-command)
- [5. Task Commands](#task-commands)
- [5.1 `addtask`](#addtask-command)
- [5.2 `showtask`](#showtask-command)
- [5.3 `done`](#done-comand)
- [5.4 `chdate`](#chdate-command)
- [5.5 `chpri`](#chpri-command)
- [5.6 `chtag`](#chtag-command)
- [5.7 `showtag`](#showtag-command)
- [6. Calendar Commands](#calendar-commands)
- [3. Login / Logout](#loginandlogout)
- [4. Category commands](#categorycommands)
- [4.1. `showcat`](#showcatcommand)
- [4.2. `addcat`](#addcatcommand)
- [4.3. `mvcat`](#mvcatcommand)
- [4.4. `rmcat`](#rmcatcommand)
- [4.5. `rncat`](#rncatcommand)
- [5. Task Commands](#taskcommands)
- [5.1. `addtask`](#addtaskcommand)
- [5.2. `showtask`](#showtaskcommand)
- [5.3. `done`](#donecommand)
- [5.4. `chdate`](#chdatecommand)
- [5.5. `chpri`](#chpricommand)
- [5.6. `chtag`](#chtagcommand)
- [5.7. `showtag`](#showtagcommand)
- [6. Calendar Commands](#calendarcommands)
- [🚒 Report Bugs](#-report-bugs)
- [😭 Uninstall](#-uninstall)
- [💌 Contributions](#-contributions)
Expand Down Expand Up @@ -67,7 +67,7 @@ Now, let's dive into Girok!

# 🔥 Get Started

## 1. Help command <a name="help-command"></a>
## 1. Help command

In order to see **all the commands** of **Girok**, enter `girok --help` in your terminal.

Expand All @@ -89,7 +89,7 @@ then you'll see the following help message

![](images/girok-command-help.png)

## 2. Register
## 2. Register <a name="register"></a>

To register a new account enter the following in your terminal.

Expand All @@ -101,7 +101,7 @@ girok register

Congratulations! Now let's go ahead and login to our account.

## 3. Login and Logout
## 3. Login and Logout <a name="loginandlogout"></a>

In order to login with your registered account, enter the following command.

Expand All @@ -113,15 +113,15 @@ girok login

Now you're ready to use all the features.

## 4. Category Commands
## 4. Category Commands <a name="categorycommands"></a>

You can pre-define **categories** such as `School`, `Life` and `Career` with automatically assigned category color.

Girok supports **infinite recursive subcategories**. All the subcategories will be assigned with the color of its topmost parent category.

Later on, you can link tasks to these categories.

### 4.1 `showcat` command
### 4.1 `showcat` command <a name="showcatcommand"></a>

In order to see all the categories you have created, enter the following command.

Expand All @@ -133,7 +133,7 @@ girok showcat

![](images/girok-addcat3.png)

### 4.2 `addcat` command
### 4.2 `addcat` command <a name="addcatcommand"></a>

`addtask` command takes a single argument `category full path`.

Expand Down Expand Up @@ -167,7 +167,7 @@ Then, you'll see `Resume` is created under `Career`.

In this way, you can create as many categories and sub-categories as you want!

### 4.3 `mvcat` command
### 4.3 `mvcat` command <a name="mvcatcommand"></a>

Now you might want to move a category under another category.

Expand All @@ -193,7 +193,7 @@ girok mvcat Dev/Network/Career /

![](images/girok-addcat5.png)

### 4.4 `rmcat` command
### 4.4 `rmcat` command <a name="rmcatcommand"></a>

Of course, you want to delete a category. In that case, enter the following command.

Expand Down Expand Up @@ -223,7 +223,7 @@ Then, you'll be asked to confirm the deletion. Enter `y`.

![](images/girok-rmcat1.png)

### 4.5 `rncat` command
### 4.5 `rncat` command <a name="rncatcommand"></a>

To rename an existing category,

Expand All @@ -233,11 +233,11 @@ girok rncat <category path> <new name>

Great job! Now let's move on to the task commands.

## 5. Task commands
## 5. Task commands <a name="taskcommands"></a>

**Girok** provides powerful task scheduling operations. You can perform different operations that would've taken in other schedulers like Notion and Google Calendar in less than 10 seconds (If you get used to the commands).

### 5.1 `addtask` command
### 5.1 `addtask` command <a name="addtaskcommand"></a>

```bash
girok addtask <task name> [One of deadline date options] [-c | --category <category path>] [-p | --priority <priority>] [-t | --time <deadline time>] [-T | --tag <tag name>]
Expand Down Expand Up @@ -332,7 +332,7 @@ girok addtask "Hangout with Jason" --tmr

Notice that the newly added task is highlighted with green color.

### 5.2 `showtask` command.
### 5.2 `showtask` command. <a name="showtaskcommand"></a>

```bash
girok showtask [--tree] Deadline date options] [-c | --category <category path>] [-p | --priority <priority>] [-T | --tag <tag name>]
Expand Down Expand Up @@ -446,7 +446,7 @@ girok showtask -p 5 --tree
girok showtask [-T | --tag <tag name>]
```

### 5.3 `done` command
### 5.3 `done` command <a name="donecommand"></a>

To complete(delete) a task, provide the `done` command followed by the task ID.

Expand All @@ -470,39 +470,39 @@ girok done 5

Notice that the task is now striked out.

### 5.4 `chdate` command
### 5.4 `chdate` command <a name="chdatecommand"></a>

To change the date of an existing task, enter the following command.

```bash
girok chdate <taskID> <yyyy/mm/dd | mm/dd>
```

### 5.5 `chpri` command
### 5.5 `chpri` command <a name="chpricommand"></a>

To change the priority of an existing task, enter the following command.

```bash
girok chpri <taskID> <priority (1~5)>
```

### 5.6 `chtag` command
### 5.6 `chtag` command <a name="chtagcommand"></a>

To change the tag of an existing task, enter the following command.

```bash
girok chtag <taskID> <tag name>
```

### 5.7 `showtag` command
### 5.7 `showtag` command <a name="showtagcommand"></a>

To view all the tags you have created so far, enter the following command.

```bash
girok showtag
```

## 6. Calendar Commands
## 6. Calendar Commands <a name="calendarcommands"></a>

The beauty of **Girok** is the **beautiful and responsive full calendar GUI**.

Expand Down

0 comments on commit 77f9e2f

Please sign in to comment.