Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
magtastic committed May 1, 2020
1 parent 6d163de commit e55872c
Show file tree
Hide file tree
Showing 17 changed files with 116 additions and 21 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*/**.DS_Store
106 changes: 97 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,102 @@
# BashTodo

Just a basic todo app for your terminal.
This is a super simple todo app. You can sort your tasks into projects and sort your task into three columns, _"TODO"_, _"DOING"_ and _"DONE"_. Every created tasks gets automatically assigned an id. Every command that changes a task requires a task ID.

![example](./assets/recording.gif)
## Commands

### **init**

## Commands
- add (adds a task)
- delete (deletes a task)
- todo (moves task to TODO)
- doing (moves task to DOING)
- done (moves task to DONE)
- change (changes task)
Initialize todos.
![init](./assets/init.gif)

### **new_project** _np_

_optional argument: <NEW_PROJECT_NAME>_

Creates a new project

![new_project](./assets/new_project.gif)

### **switch_projects** _sp_

_optional argument: <PROJECT_NAME>_

Switches focus to another project

![switch_projects](./assets/switch_projects.gif)

### **projects** _p_

Lists all projects

![projects](./assets/projects.gif)

### **change_current_project** _ccp_

_optional argument: <NEW_PROJECT_NAME>_

Renames the current project

![change_current_project](./assets/ccp.gif)

### **delete_project** _dp_

_optional argument: <PROJECT_NAME>_

Deletes a todo project

![delete_project](./assets/delete_project.gif)

### **add**

**argument: <TASK_DESCRIPTION>**

Adds a new task to Todo

![add](./assets/add.gif)

### **todo**

**argument: <TASK_ID>**

Moves a task to Todo

![todo](./assets/todo.gif)

### **doing**

**argument: <TASK_ID>**

Moves a task to Doing

![doing](./assets/doing.gif)

### **done**

**argument: <TASK_ID>**

Moves a task to Done

![done](./assets/done.gif)

### **ls**

Lists tasks in current project

![ls](./assets/ls.gif)

### **change**

**argument: <TASK_ID>**

Changes task

![change](./assets/change.gif)

### **delete** _del_

**argument: <TASK_ID>**

Deletes task

![delete](./assets/del.gif)
Binary file added assets/add.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/ccp.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/change.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/del.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/delete_project.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/doing.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/done.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/init.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/ls.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/new_project.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/projects.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/recording.gif
Binary file not shown.
Binary file added assets/switch_projects.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/todo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 18 additions & 12 deletions todomagtastic.sh
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ getCurrentProjectPath() {
return
}


# COMMANDS
command_tst() {
echo -e "${RED}Test red${NONE} more text no color but this is ${BOLD}bold${NONE} and this is ${UNDERLINE}underline.${NONE}"
Expand All @@ -52,13 +51,19 @@ command_help_menu(){
echo "Usage: $PROGRAM_NAME <command> [options]"
echo ""
echo "command:"
echo " init Initialize todos"
echo " add Adds a new task to Todo"
echo " todo Moves a task to Todo"
echo " doing Moves a task to Doing"
echo " done Moves a task to Done"
echo " change Changes task"
echo " delete Deletes task"
echo " init Initialize todos"
echo " new_project(np) Creates a new project"
echo " projects(p) Lists all projects"
echo " change_current_project(ccp) Renames the current project"
echo " switch_projects(sp) Switches focus to another project"
echo " delete_project(dp) Deletes a todo project"
echo " add Adds a new task to Todo"
echo " ls Lists tasks in current project"
echo " todo Moves a task to Todo"
echo " doing Moves a task to Doing"
echo " done Moves a task to Done"
echo " change Changes task"
echo " delete(del) Deletes task"
echo ""
}

Expand Down Expand Up @@ -100,7 +105,7 @@ command_init(){
mkdir -p "$TODO_BASE_PATH/$CURRENT_PROJECT/$DOING_FOLDER_NAME"
mkdir -p "$TODO_BASE_PATH/$CURRENT_PROJECT/$DONE_FOLDER_NAME"

echo "${BOLD}Setup complete!${NONE}"
echo -e "${BOLD}Setup complete!${NONE}"
}

command_add(){
Expand All @@ -116,9 +121,6 @@ command_add(){
echo -e "${GREEN}Task created. (id: $id)${NONE}"
}

command_del(){
command_delete $@
}

command_change(){
source $RC_FILE_LOCATION
Expand Down Expand Up @@ -253,6 +255,10 @@ command_todo(){
echo -e "${{RED}Did not find task with id: $task_id${NONE}"
}

command_del(){
command_delete $@
}

command_delete(){
source $RC_FILE_LOCATION
task_id=$@
Expand Down

0 comments on commit e55872c

Please sign in to comment.