Skip to content

Commit

Permalink
Merge pull request #8 from 0jonjo/6-create-a-row-delete-option-for-th…
Browse files Browse the repository at this point in the history
…e-user

Update readme to v1.1.2
  • Loading branch information
0jonjo authored Apr 28, 2024
2 parents b26c950 + fc6f9c8 commit a1bfd5e
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Woche

Woche is a collection of Bash scripts that assist in managing weekly tasks. It enables the creation of a new Markdown file for the current week and the addition of tasks to specific days. Woche, meaning 'week' in German, uses German day names (Montag, Dienstag, Mittwoch, Donnerstag, Freitag, Samstag, and Sonntag) for educational purposes.
Woche is a collection of Bash scripts that assist in managing weekly tasks. It enables the creation of a new Markdown file for the current week and the addition of tasks to specific days. Woche, meaning 'week' in German, uses German day names (Montag, Dienstag, Mittwoch, Donnerstag, Freitag, Samstag, and Sonntag) for educational purposes. You can choose the name of the days to English.

## Features

- Generates a new Markdown file for the current week, including headers for each day.
- Allows the addition of tasks to a specific day of the week.
- Allows the addition, editing and delete of tasks to a specific day of the week or line of the file.
- Provides usage tips.

## Usage
Expand Down Expand Up @@ -33,16 +33,32 @@ Replace <day> with the day of the week (in German: mon, die, mit, don, frei, sam

This command prints the Markdown file with the tasks for the entire week.

**4. Access instructions:**
4. **Edit a task of the current week:**

```bash
./woche.sh edit 9 "That task"
```

This command edit the line 9 of Markdown file with the tasks.

5. **Delete a task of the current week:**

```bash
./woche.sh delete 3
```

This command edit the line 3 of Markdown file.

6. **Access instructions:**

```bash
./woche.sh help
```

## Customization Tips
- Change the file creation path by modifying the path variable in the woche.sh file.
- Alter the date format in the Markdown file by adjusting the start_day.
- Switch to English day names by replacing woche_array with week_array.
- Change the file creation path by modifying the path variable in the variables.sh file.
- Switch to English day names by replacing woche_array with week_array in the same file.
- Alter the date format of the Markdown file by adjusting the start_day_of_week method in functions.sh.

## Testing

Expand Down

0 comments on commit a1bfd5e

Please sign in to comment.