diff --git a/README.md b/README.md index 2243c7a..920bc37 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,46 @@ ## GYMKHANA Calendar -__Installing and running__ + +### User guide: + +1. Adding events: + + + * Click on `+` to login. Only club IDs are allowed to add events. Request admins if club ID has to be enabled. + ![before-login](./resources/before-login.png) + + * Click on `+` again to start adding event + ![after-login](./resources/after-login.png) + + * Among below options:
+ **If `Allow Overlaps` is disabled(`No`) when creating events then other clubs will not be able to add events in that duration. Hence disable it only if necessary.** + ![events-add](./resources/events-add.png) + +------------------------------------------------------------ +* **By default Secretaries/clubs can edit only the events added through their IDs.** + +* However permission can be given to allow to edit events added by others.
To check it go to [admin page(/admin)](https://activities.iitmandi.co.in/admin) + +1. If logged in and `Allowed to schedule events` you will see: +![Allowed to schedule events](./resources/scheduling-allowed.png) + +1. If logged in and `NOT allowed to schedule events` you will see: +![scheduling-not-allowed](./resources/scheduling-not-allowed.png) +OR +![scheduling-no-permissions](./resources/scheduling-no-permissions.png) + +**If scheduling permissions are needed, kindly request the admins to add your `club ID` to `edit-event` group** + +--------------------------------------- + +### Editing events: +1. Go inside `Scheduling(admin/events/event/)` page. You can view schedule times in calendar and all the events below the calendar. +![scheduling-times](./resources/scheduling-times.png) +![scheduled-events](./resources/scheduled-events.png) +1. To edit event: just click on them, edit and save. + +--------------------------------------- +### __Installing and running__ Clone the repository diff --git a/resources/after-login.png b/resources/after-login.png new file mode 100644 index 0000000..221a597 Binary files /dev/null and b/resources/after-login.png differ diff --git a/resources/before-login.png b/resources/before-login.png new file mode 100644 index 0000000..a7908ad Binary files /dev/null and b/resources/before-login.png differ diff --git a/resources/events-add.png b/resources/events-add.png new file mode 100644 index 0000000..ba32f13 Binary files /dev/null and b/resources/events-add.png differ diff --git a/resources/scheduled-events.png b/resources/scheduled-events.png new file mode 100644 index 0000000..27214dc Binary files /dev/null and b/resources/scheduled-events.png differ diff --git a/resources/scheduling-allowed.png b/resources/scheduling-allowed.png new file mode 100644 index 0000000..c04c407 Binary files /dev/null and b/resources/scheduling-allowed.png differ diff --git a/resources/scheduling-no-permissions.png b/resources/scheduling-no-permissions.png new file mode 100644 index 0000000..5cf45a4 Binary files /dev/null and b/resources/scheduling-no-permissions.png differ diff --git a/resources/scheduling-not-allowed.png b/resources/scheduling-not-allowed.png new file mode 100644 index 0000000..a6ea310 Binary files /dev/null and b/resources/scheduling-not-allowed.png differ diff --git a/resources/scheduling-times.png b/resources/scheduling-times.png new file mode 100644 index 0000000..cc503ce Binary files /dev/null and b/resources/scheduling-times.png differ