Get started quickly
Get started quickly
Get the source code
Clone main warehouse
The KitX project uses Git for version control, and you can get the source code through the following command:
git clone git@github.com:Crequency/KitX.git --recurse-submodules
cd KitXWarning
It is not supported to obtain submodules through the https protocol. It is strongly recommended to configure local git and ssh environments
Initialize dependencies
Use cheese to select the initialization submodule and make relevant settings:
cheese reference --setup# You need dotnet sdk to execute this command
dotnet tool install cheese -gIf you encounter an error in the
cheesecommand, you can add the--verboseparameter to view detailed error information
Build a project
Preparation before compilation
- You need to install dotnet 8 SDK, please go to dotnet official website to download and install The installation is successful: the command
dotnet --list-sdkswas successfully run and the version number of the dotnet 8 SDK is listed.
Compilation
You just need cd to the project directory you want to compile (including the .csproj file), and then run the following command:
dotnet buildIf you run the command dotnet run, the project will be automatically compiled and run.
Release-oriented compilation
You may notice that there are many files with .pubxml suffix under KitX Dashboard/Properties/PublishProfiles/
These are the Publish configuration files, you can use the commands:
cd "KitX Dashboard"
dotnet publish /p:Profile=Properties/PublishProfiles/<xxx>.pubxmlTo publish using these configuration files, where <xxx> is the configuration file name
The published binary file will exist under KitX Publish/
You can also execute the following command to publish all configuration files in one click:
cheese scripts -e publishOther construction methods
You can also use some IDEs to build your project For example:
- Visual Studio (Recommended to use version 2022)
- Jetbrains Rider
Among them, you can right-click the project in Solution Explorer in Visual Studio, select Publish, and then select Publish configuration file to publish You can also use similar actions in Rider to publish
Alternatively, you can configure an editor to simplify the build steps For example:
- Visual Studio Code
- Vim
The steps to configure the editor are omitted here, please search for relevant tutorials by yourself
