Get started quickly
About 414 wordsAbout 1 min
2025-01-25
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 KitX
Warning
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 -g
If you encounter an error in the
cheese
command, you can add the--verbose
parameter 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-sdks
was 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 build
If 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>.pubxml
To 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 publish
Other 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
Changelog
Last Updated: View All Changelog
💾 Feat: Updating translation for English
On 2/8/25💾 Feat(Plume-Theme): Migrated
On 1/25/25📝 Chore: Remove hard-coded permalink
On 1/25/25📦 Struct: Move to
On 1/25/25notes
folder to match theme's requirementsv23.05.06.0
On 5/6/23📄 Docs(getting-started): Part of start list.
On 3/27/23📦 Struct: Move all files under
On 3/22/23en/guide
toen/client/guide
📦 Struct: Move default to root dir
On 2/21/23📄 Docs: 英文文档
On 1/21/23📝 📦 Chore, Struct: 按主题分离
On 1/21/23📝 📦 Chore, Struct: 尝试 hope 主题
On 1/21/23📄 📝 Docs, Chore: 初始化项目架构; 初始化文档架构
On 1/20/23💾 📝 📦 Feat, Chore, Struct: 使用 vuepress 重建文档站
On 1/20/23