@@ -26,6 +26,8 @@ GitHub-style markdown.
26
26
1 . [ Installing] ( #installing )
27
27
1 . [ Installing from source] ( #installing-from-source )
28
28
2 . [ Running] ( #running )
29
+ 3 . [ How to use] ( #how-to-use )
30
+ 4 . [ Options] ( #options )
29
31
30
32
## Installing
31
33
@@ -154,4 +156,37 @@ cd path/to/the/CircuitPython-Project-Manager
154
156
```
155
157
Don't forget to give the ` .sh ` file execute permission! (` chmod +x shell_file.sh ` )
156
158
159
+ [ Back to table of contents] ( #table-of-contents )
160
+
161
+ ## How to use
162
+
163
+ Nothing here yet!
164
+
165
+ [ Back to table of contents] ( #table-of-contents )
166
+
167
+ ## Options
168
+
169
+ You can find these options in ` config.json ` , which is in the same directory as
170
+ [ ` main.py ` ] ( https://github.com/UnsignedArduino/CircuitPython-Project-Manager/blob/main/main.py ) , and should be
171
+ auto-generated upon first run. In case it does not happen, (file a issue?) this is the default JSON file:
172
+ ``` json
173
+ {
174
+ "last_dir_opened" : " E:\\ Test" ,
175
+ "opened_recent" : [
176
+ " E:\\ Test\\ Untitled\\ .cpypmconfig"
177
+ ],
178
+ "show_traceback_in_error_messages" : false ,
179
+ "unix_drive_mount_point" : " /media"
180
+ }
181
+ ```
182
+ - ` last_dir_opened ` should be a string of a path that points to the last directory that you opened, so the next time
183
+ you open a file/directory, you will start there! It will be set once you open a directory/file, and ** will not appear
184
+ immediately.**
185
+ - ` opened_recent ` should be a list of strings which are the paths of projects you last opened. It will be set once you
186
+ open/create a new project, and ** will not appear immediately.**
187
+ - ` show_traceback_in_error_messages ` should be a boolean. (Either ` true ` or ` false ` ) This will control whether stack
188
+ traces will appear in error messages.
189
+ - ` unix_drive_mount_point ` should be a string of a path that points to the place where your distro automatically mounts
190
+ drives. Only applies to Unix-based systems.
191
+
157
192
[ Back to table of contents] ( #table-of-contents )
0 commit comments