Skip to content

Commit eb75a93

Browse files
committed
docs: update explanatory comments in config.ini
1 parent 5f6ac37 commit eb75a93

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

config.ini.template

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,24 @@
22
username = your_weduc_username
33
password = your_weduc_password
44

5-
# The next entry is optional. The default Ubuntu Linux Chromium path will be used
6-
# if this is not specified.
7-
chromium_path = path to where Playwright should look for Chromium browser
5+
; The next entry is optional. The default path for the current OS will be used
6+
; if this is not specified.
7+
; Note: Chrome Browser for Windows / MacOS. Chromium Browser for Ubuntu Linux.
8+
; These are typically the versions that users of these OSes install.
9+
chromium_path = path to where Playwright should look for Browser
810

911
[ical]
10-
# The next entry is only needed if running in `ical` mode.
12+
; The next entry is only needed if running in `ical` mode.
1113
output_folder_path = the folder where iCalendar files should be written out to
1214

1315
[student_1]
1416
school_id = the Weduc ID of the school to which the student belongs
1517
student_id = the Weduc ID of the student
16-
# The next entry is only needed if running in 'api' mode.
18+
; The next entry is only needed if running in 'api' mode.
1719
calendar_to_update = the name of the calendar, in Google, to which Weduc events should be pushed
1820

19-
# [student_2]
20-
# ... as above, but for another student
21+
; [student_2]
22+
; ... as above, but for another student
2123

22-
# [student_3]
23-
# ... etc
24+
; [student_3]
25+
; ... etc

0 commit comments

Comments
 (0)