From 52dade82b1feb18bdfc8f83d57b4dda7421d6c2d Mon Sep 17 00:00:00 2001 From: wj-xiao Date: Thu, 3 Apr 2025 14:14:47 +0800 Subject: [PATCH] update README.md --- README.md | 4 ++-- browser/README.md | 2 +- desktop/README.md | 24 ++++++++++++++++++++++++ 3 files changed, 27 insertions(+), 3 deletions(-) create mode 100644 desktop/README.md diff --git a/README.md b/README.md index cc5d2e4..b816ef3 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ NanoKVM-USB captures HDMI video signals and transmits them to the host via USB 3 ![interface](https://wiki.sipeed.com/hardware/assets/NanoKVM/usb/interface.jpg) -## Releases +## Versions -We offer two versions of the application: **Browser** and **Desktop**. Both are available on the [Releases page](https://github.com/sipeed/NanoKVM-USB/releases). +We offer two versions of the application: [Browser](https://github.com/sipeed/NanoKVM-USB/tree/main/browser) and [Desktop](https://github.com/sipeed/NanoKVM-USB/tree/main/desktop). Both are available on the [Releases page](https://github.com/sipeed/NanoKVM-USB/releases). ### Browser Version diff --git a/browser/README.md b/browser/README.md index 4e6c4b0..99d48cc 100644 --- a/browser/README.md +++ b/browser/README.md @@ -7,7 +7,7 @@ Online website: [usbkvm.sipeed.com](https://usbkvm.sipeed.com). ## Development ```shell -cd web +cd browser pnpm install pnpm dev ``` diff --git a/desktop/README.md b/desktop/README.md new file mode 100644 index 0000000..263cb25 --- /dev/null +++ b/desktop/README.md @@ -0,0 +1,24 @@ +# NanoKVM-USB Desktop + +This is the NanoKVM-USB desktop version project. + +## Development + +```shell +cd desktop +pnpm install +pnpm start +``` + +## Compile + +```shell +# For Windows +pnpm build:win + +# For MacOS +pnpm build:mac + +# For Linux +pnpm build:linux +```