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
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ This is a serial ISP flashing tool for WCH RISC-V microcontrollers that runs in
4
4
5
5
It uses the JavaScript [Web Serial](https://developer.mozilla.org/en-US/docs/Web/API/SerialPort) browser API, and so requires support for this feature by the browser. At time of writing, only the following browsers feature support for the Web Serial API: Chrome version 89+, Edge version 89+, Opera version 76+. This tool does not work in FireFox and Safari, due to lack of support for the API.
6
6
7
+
> [!NOTE]
7
8
> **You can find a hosted version of this tool on my website, at: [https://www.stasisleak.uk/wchisp/](https://www.stasisleak.uk/wchisp/).**
8
9
9
10
## Features
@@ -29,15 +30,28 @@ Currently supported RISC-V WCH microcontrollers:
29
30
* CH32V30x
30
31
* CH32X03x
31
32
32
-
## Self-Hosting
33
+
## Building
33
34
34
-
If you want to deploy a copy of this tool to be hosted on your own web server, installation is simple:
35
+
> [!NOTE]
36
+
> **A pre-built copy can be found in the Releases section of the GitHub repository.**
35
37
36
-
1. Copy all files and sub-folders to a location of your choice on your web server.
37
-
2. Load that server URL in your web browser.
38
-
3. Done! Nothing else required. 😄
38
+
Building requires the bundling tool [esbuild](https://esbuild.github.io/), a copy of which needs be installed in a `tools\esbuild` sub-folder of the project. Please note building is currently only supported on Windows.
39
39
40
-
Please note that it is not possible to run this tool locally by loading `index.html` into a browser (i.e. straight from the filesystem via `file://`) due to [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) JS module restrictions.
40
+
To build:
41
+
42
+
1. Open a command prompt in the project folder.
43
+
2. Run `build.bat`.
44
+
3. The resultant HTML, JS, and CSS files will be output to the `dist` sub-folder.
45
+
46
+
If any Linux/Mac users are feeling resourceful, they may wish to review the contents of `build.bat` and translate the script within to an appropriate shell script or discrete commands. 😄
47
+
48
+
## Running
49
+
50
+
If you downloaded a pre-built release, first extract the contents of the zip file to a location of your choice.
51
+
52
+
Open in your web browser the `index.html` file from the `dist` folder.
53
+
54
+
If you want to deploy a copy of this tool to be hosted on your own web server, simply upload all files within the `dist` folder to a location of your choice on your web server.
0 commit comments