Skip to content

Commit 2c945a3

Browse files
committed
Update DOC's n manuals
1 parent 49b8bea commit 2c945a3

6 files changed

Lines changed: 28 additions & 20 deletions

doc/USBSID-Pico-firmware-manual.adoc

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,32 @@ or
7575

7676
== Firmware configuration
7777
USBSID-Pico has an extensive set of configuration options that expands with each firmware release. +
78-
At this point in time you can change the settings to your liking by using the configuration webpage or the CLI config tool. +
79-
webpage: https://usbsid.loudai.nl/index.html?player=webusb&debug=usbsidpico +
78+
79+
=== Configuration tool
80+
You can configurate your board by using the commandline config-tool or together with the Python Configuration GUI by ISL/Samar if you prefer a GUI.
81+
82+
==== GUI downloads
83+
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/cfg_usbsid_GUI.py[Download script] +
84+
Python3 -> https://www.python.org/downloads/[Download] +
85+
TkInter -> https://tkdocs.com/tutorial/install.html[Installation guide] +
86+
And either one of the Linux or Windows CLI downloads below
87+
88+
==== Linux downloads
89+
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/cfg_usbsid[Download executable]
90+
91+
==== Windows downloads
92+
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/cfg_usbsid.exe[Download executable] +
93+
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/libusb-1.0.dll[Download DLL 1] +
94+
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/libwinpthread-1.dll[Download DLL 2]
95+
96+
=== Configuration web page (for Chrome/Edge based browsers using webusb)
97+
https://usbsid.loudai.nl/?player=webusb&debug=usbsidpico[USBSID web configuration tool] (requires a Chrome based browser). +
98+
If needed you can change your USBSID configuration after selecting WebUSB and clicking on `Open config`. +
99+
image:images/firmware/usbsidpico-config-dark.png[Title=Config Dark,300]image:images/firmware/usbsidpico-config-light.png[Title=Config Light,300] +
100+
_The player is set up with borrowed code from Deepsid using Hermit's JsSID implementation._
101+
102+
==== Debug functions
103+
For additional testing there are some debug functions available on the https://usbsid.loudai.nl/?player=webusb&debug=usbsidpicoUSBSID Debug site (requires a Chrome based browser).
80104

81105
=== Default configuration
82106
Each firmware version comes with the same default configuration. +
@@ -235,22 +259,6 @@ _This config setting is intended for future use_
235259
Available options are: +
236260
`False`, `True`
237261

238-
== Config tools
239-
240-
=== Configuration web page
241-
https://usbsid.loudai.nl/?player=webusb&debug=usbsidpico[usbsid.loudai.nl]
242-
243-
=== CLI Configuration tool (linux)
244-
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/cfg_usbsid[Download executable]
245-
246-
=== CLI Configuration tool (Windows)
247-
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/cfg_usbsid.exe[Download executable] +
248-
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/libusb-1.0.dll[Download DLL 1] +
249-
https://github.com/LouDnl/USBSID-Pico/blob/master/examples/config-tool/libwinpthread-1.dll[Download DLL 2]
250-
251-
=== Multiplatform Configuration GUI
252-
t.b.d. (help wanted)
253-
254262
== Disclaimer
255263
include::disclaimer.adoc[]
256264

959 KB
Binary file not shown.

doc/USBSID-Pico-software-manual.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,10 +199,10 @@ To get to these settings follow the following settings path: +
199199
t.b.d.
200200

201201
=== jsidplay2
202-
This section covers the use of USBSID-Pico with `c64jukebox` website that runs on `jsidplay2`
202+
This section covers the use of USBSID-Pico with `jsidplay2`
203203

204204
==== c64jukebox
205-
t.b.d.
205+
`c64jukebox` website that runs on `jsidplay2`
206206

207207
=== sidplayfp
208208
t.b.d.
63 Bytes
Binary file not shown.
561 KB
Loading
681 KB
Loading

0 commit comments

Comments
 (0)