diff options
author | Jason Lee <changjin9792@gmail.com> | 2023-03-24 14:20:01 +0800 |
---|---|---|
committer | Jason Lee <changjin9792@gmail.com> | 2023-03-24 14:20:01 +0800 |
commit | b59da0ad871913c145323754a965679de6aa62ae (patch) | |
tree | 71d280a6204dd8013676b14f17a19ee852168d9f | |
parent | 3567c982b816c9012a93c6af10a39233691e0167 (diff) |
README.md update
-rw-r--r-- | README.md | 106 | ||||
-rw-r--r-- | images/girok-addcat1.png | bin | 0 -> 93510 bytes | |||
-rw-r--r-- | images/girok-addcat2.png | bin | 0 -> 100112 bytes | |||
-rw-r--r-- | images/girok-addcat3.png | bin | 0 -> 92392 bytes | |||
-rw-r--r-- | images/girok-addcat4.png | bin | 0 -> 199430 bytes | |||
-rw-r--r-- | images/girok-addcat5.png | bin | 0 -> 107678 bytes | |||
-rw-r--r-- | images/girok-addcat6.png | bin | 0 -> 104861 bytes | |||
-rw-r--r-- | images/girok-rmcat1.png | bin | 0 -> 130808 bytes |
8 files changed, 105 insertions, 1 deletions
@@ -117,9 +117,113 @@ Now you're ready to use all the features. ## 4. Category Commands +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 -### +In order to see all the categories you have created, enter the following command. + +By default, `No Category` category is set (later for tasks which have no category). + +```bash +girok showcat +``` + +![](images/girok-addcat3.png) + +### 4.2 `addcat` command + +`addtask` command takes a single argument `category full path`. + +In order to add a new category, enter the following command. + +```bash +girok addcat <target path> +``` + +The `<target path>` is the **full path including the new category name**. For example, if you want to add a **topmost category** named `Career`, then enter + +```bash +girok addcat Career +``` + +Then, you'll see the category tree with the newly created category being highlighted. + +![](images/girok-addcat1.png) + +In order to nest a sub-category under a previously defined category, pass the **FULL PATH** starting from the topmost category delimited by `/`, ending with the new category name. + +For example, if you want to create a new category named `Resume` under the previously created `Career` category, enter the following command. + +```bash +girok addcat Career/Resume +``` + +Then, you'll see `Resume` is created under `Career`. + +![](images/girok-addcat2.png) + +In this way, you can create as many categories and sub-categories as you want! + +### 4.3 `mvcat` command + +Now you might want to move a category under another category. + +In order to move a `category A` (recursively all its sub-categories) under `category B`, enter the following command. + +```bash +girok mvcat <full path of A> <full path of B> +``` + +For example, if you want to move the whole `Career` category under `Dev/Network` (for some weird reason), enter the following command. + +```bash +girok mvcat Career Dev/Network +``` + +![](images/girok-addcat4.png) + +If you want to move a category to the `root category`, then pass `/` as the second argument. Let's move `Dev/Network/Career` back to the topmost category. + +```bash +girok mvcat Dev/Network/Career / +``` + +![](images/girok-addcat5.png) + +### 4.4 `rmcat` command + +Of course, you want to delete a category. In that case, enter the following command. + +```bash +girok rmcat <full path of category> +``` + +Let's add a dummy category named `Dummy` under `Dev` then remove it. + +As you already know, enter + +```bash +git addcat Career/Dummy +``` + +![](images/girok-addcat6.png) + +Now, let's delete it with the following command. + +```bash +girok rmcat Career/Dummy +``` + +Then, you'll be asked to confirm the deletion. Enter `y`. + +![](images/girok-rmcat1.png) + +Great job! Now let's move on to the task commands. ## 5. Task commands diff --git a/images/girok-addcat1.png b/images/girok-addcat1.png Binary files differnew file mode 100644 index 0000000..592d8d9 --- /dev/null +++ b/images/girok-addcat1.png diff --git a/images/girok-addcat2.png b/images/girok-addcat2.png Binary files differnew file mode 100644 index 0000000..eb9e345 --- /dev/null +++ b/images/girok-addcat2.png diff --git a/images/girok-addcat3.png b/images/girok-addcat3.png Binary files differnew file mode 100644 index 0000000..e582493 --- /dev/null +++ b/images/girok-addcat3.png diff --git a/images/girok-addcat4.png b/images/girok-addcat4.png Binary files differnew file mode 100644 index 0000000..5f121d3 --- /dev/null +++ b/images/girok-addcat4.png diff --git a/images/girok-addcat5.png b/images/girok-addcat5.png Binary files differnew file mode 100644 index 0000000..7545b09 --- /dev/null +++ b/images/girok-addcat5.png diff --git a/images/girok-addcat6.png b/images/girok-addcat6.png Binary files differnew file mode 100644 index 0000000..4132ed1 --- /dev/null +++ b/images/girok-addcat6.png diff --git a/images/girok-rmcat1.png b/images/girok-rmcat1.png Binary files differnew file mode 100644 index 0000000..0afbf27 --- /dev/null +++ b/images/girok-rmcat1.png |