You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+66-1Lines changed: 66 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -223,7 +223,72 @@ Once you make a new project, it will open automatically in the main window. On t
223
223
224
224
### Managing projects
225
225
226
-
Nothing here just yet!
226
+
After opening a project (or creating it) you will be presented with a fairly large window as my applications go at the
227
+
time of this writing with tons of buttons which is always fun.
228
+
229
+
Figure 2.5: A standard project after creation.
230
+
231
+

232
+
233
+
Let's outline them in colorful boxes, and I'll tell you what each one does!
234
+
235
+
Figure 2.6: A standard project after creation but with colorful boxes around all the UI elements.
236
+
237
+

238
+
239
+
1. In purple, this is where you can modify the project title.
240
+
2. In dark-blue, this is where you can modify the project description.
241
+
3. In blue, this is a list of the files and **whole** directories that will be synced.
242
+
4. In green, this is how you can include and exclude files and directories you want to sync.
243
+
5. In yellow, this is where you can save and discard all your changes after changing some stuff around. Pressing the
244
+
`Sync` button will also sync the listed files and directories to the drive listed as the target.
245
+
6. In orange, this is the location of the drive. You may recognize this from my previous project the
246
+
[CircuitPython Bundle Manager](https://github.com/UnsignedArduino/CircuitPython-Bundle-Manager) (Oh no more shameless
247
+
self promotion) and yes I totally did not copy and paste the code from it. I would never do such a thing. It's the
248
+
same interface too because ~~I'm all about consistency.~~ But if you don't know, it's a combo box which will list
249
+
all the connected CircuitPython devices, unless the `Show all drives` checkbutton is, checked. And the refresh button
250
+
will refresh the list of connected drives.
251
+
7. In red, this is the menu bar. We will go more in depth and description and explain all the magic that happens in
252
+
[The menu-bar in depth](#the-menu-bar-in-depth) section coming up.
253
+
254
+
If you want to add a file to be synced, say if you were making a lightsaber with sound effects, you may want to sync an
255
+
`.mp3` file with lightsaber noises. To do that, just copy the `.mp3` file into the project directory. (Which you can
256
+
open by clicking on the `Edit` menu casacade and pressing `Open .cpypmconfig file location` because by default, the
257
+
`.cpypmconfig` file defaults to being in the root of your project, unless you moved it. Why would you move it???) Next
258
+
press the `Add file` button and a file selector pops up. Select the `.mp3` file and if all goes to plan, it should
259
+
appear in your list of files and directories to sync!
260
+
261
+
If you want to add a whole directory to be synced, like if you were making a slide show, then copy the directory full
262
+
of pictures into the project and press `Add directory` and select that directory to sync. If all goes well, it should
263
+
appear in the list of files and directories to sync!
264
+
265
+
Now if you want to sync your stuff, you must first select a CircuitPython drive. Click on the drop-down icon and select
266
+
a drive. If you can't find it, than you may benefit from selecting `Show all drives?` and checking again. If that still
267
+
doesn't work (file an issue?) then you can enter the path of the device manually too.
268
+
269
+
If you are on Linux, depending on where your distribution mounts drives, you may not find any unless you edit the
270
+
application's configuration file. To do so, press on the `Help` casacade and select the `Open configuration` command.
271
+
This will open the configuration file in the default `.json` application.
272
+
273
+
Figure 2.7: My configuration file before editing.
274
+
275
+

276
+
277
+
Now if your distro mounts drives in say, `/media/pi`, then edit the `unix_drive_mount_point` attribute and save.
278
+
279
+
Figure 2.8: My configuration file after editing.
280
+
281
+

282
+
283
+
Now after editing you may be wondering _why isn't it working??? It won't let me press the button!!! Your software is
284
+
broken and I'm never gonna use it ever again!!!_ You'll need to press the `Save` button and if all things go right,
285
+
everything should go grey for a second and back to normal. You should be able to sync!
286
+
287
+
To sync, press the `Sync` button. (wow I would have never thought that) A teensy tiny dialog will pop up saying
288
+
"Syncing..." and once the sync is done it will disappear. That's it! You can also press <kbd>Ctrl</kbd> + <kbd>R</kbd>
289
+
(<kbd>Cmd</kbd> + <kbd>R</kbd> for the folks in macOS land) to sync too or use the sync command in the `Sync` casacade.
290
+
291
+
Next we'll ~~do some shameless self promotion~~ and figure out how to manage dependencies.
0 commit comments