From 1cf10952338e2779ff4e02e3444daaa136ea7419 Mon Sep 17 00:00:00 2001 From: David DeVore Date: Sun, 1 Oct 2023 15:43:31 -0400 Subject: [PATCH 1/5] Documentation Cleanup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a955a71..9e457be 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ > Don't let the fear of the time it will take to accomplish something stand in the way of your doing it. The time will pass anyway; we might just as well put that passing time to the best possible use. - Earl Nightingale -ScheduleBot is a Python application that helps you calendarize events and work through a Discord bot. Want to try it out? ~~[Invite the bot into a server](https://discord.com/api/oauth2/authorize?client_id=884865269867102249&permissions=534723951680&scope=bot), and afterward you can DM the bot. (To be implemented in the future)~~ Join the [ScheduleBot server](https://discord.gg/xRaact5GmH) and DM the bot. +ScheduleBot is a Python application that helps you calendarize events and work through a Discord bot. Want to try it out? Join the [ScheduleBot server](https://discord.gg/xRaact5GmH) and DM the bot. With ScheduleBot you can quickly schedule events, state your prefered times for certain types of activities (exercise, homework, meetings, etc.) and quickly find out which times you have available to do more stuff. From 5e0e9e7cf5577bea00e5fde5ddc0b8f33220edcb Mon Sep 17 00:00:00 2001 From: David DeVore Date: Sun, 1 Oct 2023 15:47:02 -0400 Subject: [PATCH 2/5] More documentation updates --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9e457be..62fcb66 100644 --- a/README.md +++ b/README.md @@ -67,14 +67,6 @@ The bot will ask you for the name of the type and your preferred times. ![Type Create](docs/img/Type%20Create.gif) - -## Releases - -- [All releases](https://github.com/lyonva/ScheduleBot/releases) -- Latest: [v0](https://github.com/lyonva/ScheduleBot/releases/tag/v0) - -## Documentation - ## Getting involved Thank you for caring for this project and getting involved. To start, please check out [contributing](https://github.com/lyonva/ScheduleBot/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/lyonva/ScheduleBot/blob/main/CODE_OF_CONDUCT.md). For more technical detail of implementation of code, you can check out the documentation. When you want to get your hands on the project, take a peek into the [github project](https://github.com/lyonva/ScheduleBot/projects/1), assign yourself a task, move it to To-Do, and convert it into an issue and assign it to yourself. @@ -122,3 +114,8 @@ It will find and schedule the first available X contiguous hours, on your prefer \[Screenshot\] \[Add more future functionality\] + +## Releases + +- [All releases](https://github.com/lyonva/ScheduleBot/releases) +- Latest: [v0](https://github.com/lyonva/ScheduleBot/releases/tag/v0) \ No newline at end of file From c7d1c85d4d114011100217bbea02a9416b778d65 Mon Sep 17 00:00:00 2001 From: David DeVore Date: Sun, 1 Oct 2023 15:50:41 -0400 Subject: [PATCH 3/5] More documentation updates --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 62fcb66..9c8abab 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,16 @@ The bot will ask you for the name of the type and your preferred times. ![Type Create](docs/img/Type%20Create.gif) + +## Releases + +- [All releases](https://github.com/lyonva/ScheduleBot/releases) +- Latest: [v0](https://github.com/lyonva/ScheduleBot/releases/tag/v0) + +## Documentation + +- [Online Documentation](https://lyonva.github.io/ScheduleBot/) + ## Getting involved Thank you for caring for this project and getting involved. To start, please check out [contributing](https://github.com/lyonva/ScheduleBot/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/lyonva/ScheduleBot/blob/main/CODE_OF_CONDUCT.md). For more technical detail of implementation of code, you can check out the documentation. When you want to get your hands on the project, take a peek into the [github project](https://github.com/lyonva/ScheduleBot/projects/1), assign yourself a task, move it to To-Do, and convert it into an issue and assign it to yourself. @@ -114,8 +124,3 @@ It will find and schedule the first available X contiguous hours, on your prefer \[Screenshot\] \[Add more future functionality\] - -## Releases - -- [All releases](https://github.com/lyonva/ScheduleBot/releases) -- Latest: [v0](https://github.com/lyonva/ScheduleBot/releases/tag/v0) \ No newline at end of file From a2209adae71908b966d4177c3ced0c957efa70c6 Mon Sep 17 00:00:00 2001 From: David DeVore Date: Sun, 1 Oct 2023 15:59:13 -0400 Subject: [PATCH 4/5] Update instructions of bot-use. --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9c8abab..94a0aaf 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,17 @@ The bot will ask you the details of your new event. ![Schedule](docs/img/Schedule.gif) +As you can see, following the intitial prompt to the bot, it will ask about the following information: + +- 1. The name of your event. +- 2. The start and end dates of your event. +- 3. The type of your event. It is also worth noting that you can edit the list of event types that the bot knows. +- 4. The description of your event. This information is optional. If you do not have a description to add to your event, you can simply put: + +``` +!done +``` + ### **I forgot my agenda for the day** You can take a look at your events scheduled for the day with the command: @@ -67,12 +78,6 @@ The bot will ask you for the name of the type and your preferred times. ![Type Create](docs/img/Type%20Create.gif) - -## Releases - -- [All releases](https://github.com/lyonva/ScheduleBot/releases) -- Latest: [v0](https://github.com/lyonva/ScheduleBot/releases/tag/v0) - ## Documentation - [Online Documentation](https://lyonva.github.io/ScheduleBot/) @@ -124,3 +129,8 @@ It will find and schedule the first available X contiguous hours, on your prefer \[Screenshot\] \[Add more future functionality\] + +## Releases + +- [All releases](https://github.com/lyonva/ScheduleBot/releases) +- Latest: [v0](https://github.com/lyonva/ScheduleBot/releases/tag/v0) \ No newline at end of file From fa103225c8a27104ec342fa9f067316055e67976 Mon Sep 17 00:00:00 2001 From: David DeVore Date: Sun, 1 Oct 2023 19:03:42 -0400 Subject: [PATCH 5/5] Update instructions of bot-use. --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 94a0aaf..7ff74cf 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ ScheduleBot is a Python application that helps you calendarize events and work t With ScheduleBot you can quickly schedule events, state your prefered times for certain types of activities (exercise, homework, meetings, etc.) and quickly find out which times you have available to do more stuff. +ScheduleBot is perfect for students, especially those who do a lot of their collabroation through Discord. This bot allows you to keep more information all in one place and minimize having to use an external tool just for scheduling your day-to-day activites. + ![Setup](docs/img/Startup.gif) ## Getting started @@ -45,10 +47,10 @@ The bot will ask you the details of your new event. As you can see, following the intitial prompt to the bot, it will ask about the following information: -- 1. The name of your event. -- 2. The start and end dates of your event. -- 3. The type of your event. It is also worth noting that you can edit the list of event types that the bot knows. -- 4. The description of your event. This information is optional. If you do not have a description to add to your event, you can simply put: +- The name of your event. +- The start and end dates of your event. +- The type of your event. It is also worth noting that you can edit the list of event types that the bot knows (take a look at the "I don't really want to work at 3.a.m." section below for more details). +- The description of your event. This information is optional. If you do not have a description to add to your event, you can simply put: ``` !done @@ -78,9 +80,9 @@ The bot will ask you for the name of the type and your preferred times. ![Type Create](docs/img/Type%20Create.gif) -## Documentation +## Additional Documentation -- [Online Documentation](https://lyonva.github.io/ScheduleBot/) +- [Additional Documentation](https://lyonva.github.io/ScheduleBot/) ## Getting involved