From 48bf463db28e702efc131678a4e2c8cd1725323d Mon Sep 17 00:00:00 2001 From: Dynesshely Date: Sun, 31 Mar 2024 22:13:24 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20Docs:=20Updated=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5765d894..6ef0b533 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,16 @@ Based on `.NET 8` platform. -Using [Avalonia UI](https://avaloniaui.net) as UI framework, using `Avalonia 11.0` . +Using [Avalonia UI](https://avaloniaui.net) as UI framework, version `Avalonia 11.0` . # Clone -We strongly suggest you to develop `KitX Dashboard` in `KitX Project` folder structure, visit [dependencies](#dependencies) for more. +We strongly suggest you to develop `KitX Dashboard` in `KitX Project` main repo, visit [dependencies](#dependencies) for more. Instead of cloning almost total `KitX Project`, you can only clone `KitX Dashboard`. ```shell -git clone git@github.com:Crequency/KitX=Dashboard.git +git clone git@github.com:Crequency/KitX-Dashboard.git # or git clone https://github.com/Crequency/KitX-Dashboard.git ``` @@ -61,14 +61,11 @@ git clone git@github.com:Crequency/KitX.git cd KitX # Init submodules -git submodule init - -# Update submodules -# If you are developing on Windows OS, replace `start.sh` with `start.ps1` -# which requires powershell installed -# WARN: We're developing new `cheese` program to replace `start.sh` and `start.ps1` -./ToolKits/start.sh dashboard -./ToolKits/start.sh reference +git submodule update --init --recursive + +# Install cheese via `dotnet tool install --global Crequency.Cheese` +# If you have no ssh key for github, you can use https style link by append `--convert-ssl-link-to-https-link` +cheese reference --setup ``` Local dependencies are located at `KitX/Reference/` folder.