From 9eb0803d10a1c8c396e17b6c55360add75e8f066 Mon Sep 17 00:00:00 2001 From: ykiko Date: Sat, 6 Sep 2025 00:07:34 +0800 Subject: [PATCH] Fix org name and update README (#235) --- README.md | 12 ++++++++---- cmake/llvm_setup.cmake | 2 +- docs/.vitepress/config.ts | 2 +- docs/en/dev/build.md | 8 ++++---- docs/zh/dev/build.md | 8 ++++---- src/Driver/clice.cc | 2 +- xmake.lua | 18 +++++++++--------- 7 files changed, 28 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 1f95772e..234eab09 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ # clice ![C++ Standard](https://img.shields.io/badge/C++-23-blue.svg) -[![GitHub license](https://img.shields.io/github/license/clice-project/clice)](https://github.com/clice-project/clice/blob/main/LICENSE) -[![Actions status](https://github.com/clice-project/clice/workflows/CI/badge.svg)](https://github.com/clice-project/clice/actions) +[![GitHub license](https://img.shields.io/github/license/clice-io/clice)](https://github.com/clice-io/clice/blob/main/LICENSE) +[![Actions status](https://github.com/clice-io/clice/workflows/CI/badge.svg)](https://github.com/clice-io/clice/actions) [![Documentation](https://img.shields.io/badge/view-documentation-blue)](https://clice.io) -[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/clice-project/clice) +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/clice-io/clice) [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.gg/PA3UxW2VA3) clice is a next-generation language server designed for modern C++. Through excellent asynchronous task scheduling and intelligent caching, it achieves a lower memory footprint and faster response times. @@ -18,7 +18,7 @@ Beyond performance, clice provides instantiation-aware template processing, supp ## Getting started -Download the latest `clice` binary from the [releases page](https://github.com/clice-project/clice/releases) and install the [vscode extension](https://marketplace.visualstudio.com/items?itemName=ykiko.clice-vscode). Then, add the following configuration to your `.vscode/settings.json` file: +Download the latest `clice` binary from the [releases page](https://github.com/clice-io/clice/releases) and install the [vscode extension](https://marketplace.visualstudio.com/items?itemName=ykiko.clice-vscode). Then, add the following configuration to your `.vscode/settings.json` file: ```jsonc { @@ -32,3 +32,7 @@ Download the latest `clice` binary from the [releases page](https://github.com/c > [!NOTE] > As an early version, please do not use it in a production environment. Crashes are expected, and we welcome you to submit issues. + +## Documentation + +To learn more about building, installing, and configuring clice, or to dive deep into its features and architecture, please visit our official documentation at [**clice.io**](https://clice.io/). \ No newline at end of file diff --git a/cmake/llvm_setup.cmake b/cmake/llvm_setup.cmake index bce0b835..11612a98 100644 --- a/cmake/llvm_setup.cmake +++ b/cmake/llvm_setup.cmake @@ -146,7 +146,7 @@ function(install_prebuilt_llvm llvm_ver) # Download if file does not exist if(NOT EXISTS "${DOWNLOAD_PATH}") message(STATUS "Downloading prebuilt LLVM package: ${LLVM_PACKAGE}") - set(DOWNLOAD_URL "https://github.com/clice-project/llvm-binary/releases/download/${llvm_ver}/${LLVM_PACKAGE}") + set(DOWNLOAD_URL "https://github.com/clice-io/llvm-binary/releases/download/${llvm_ver}/${LLVM_PACKAGE}") file(DOWNLOAD "${DOWNLOAD_URL}" "${DOWNLOAD_PATH}" STATUS DOWNLOAD_STATUS diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 40e66f06..8d7ae113 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -32,7 +32,7 @@ export default defineConfig({ }, socialLinks: [ { icon: 'discord', link: 'https://discord.gg/PA3UxW2VA3' }, - { icon: 'github', link: 'https://github.com/clice-project/clice' }, + { icon: 'github', link: 'https://github.com/clice-io/clice' }, ], outline: 'deep', diff --git a/docs/en/dev/build.md b/docs/en/dev/build.md index 5ea95f15..a88be58c 100644 --- a/docs/en/dev/build.md +++ b/docs/en/dev/build.md @@ -45,14 +45,14 @@ Besides this method, there are two other ways to obtain the llvm libs required b # Linux precompiled binary require glibc 2.35 (build on ubuntu 22.04) $ mkdir -p ./.llvm -$ curl -L "https://github.com/clice-project/llvm-binary/releases/download/20.1.5/x86_64-linux-gnu-release.tar.xz" | tar -xJ -C ./.llvm +$ curl -L "https://github.com/clice-io/llvm-binary/releases/download/20.1.5/x86_64-linux-gnu-release.tar.xz" | tar -xJ -C ./.llvm # MacOS precompiled binary require macos15+ $ mkdir -p ./.llvm -$ curl -L "https://github.com/clice-project/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-release.tar.xz" | tar -xJ -C ./.llvm +$ curl -L "https://github.com/clice-io/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-release.tar.xz" | tar -xJ -C ./.llvm # Windows precompiled binary only MD runtime support -$ curl -O -L "https://github.com/clice-project/llvm-binary/releases/download/20.1.5/x64-windows-msvc-release.7z" +$ curl -O -L "https://github.com/clice-io/llvm-binary/releases/download/20.1.5/x64-windows-msvc-release.7z" $ 7z x x64-windows-msvc-release.7z "-o.llvm" ``` @@ -66,7 +66,7 @@ $ 7z x x64-windows-msvc-release.7z "-o.llvm" 2. Compile llvm/clang from scratch -This is the most recommended approach, ensuring environment consistency and avoiding crash issues caused by ABI inconsistencies. We provide a script for building the llvm libs required by clice: [build-llvm-libs.py](https://github.com/clice-project/clice/blob/main/scripts/build-llvm-libs.py). +This is the most recommended approach, ensuring environment consistency and avoiding crash issues caused by ABI inconsistencies. We provide a script for building the llvm libs required by clice: [build-llvm-libs.py](https://github.com/clice-io/clice/blob/main/scripts/build-llvm-libs.py). ```bash $ cd llvm-project diff --git a/docs/zh/dev/build.md b/docs/zh/dev/build.md index 7b89cb56..83cb5a5a 100644 --- a/docs/zh/dev/build.md +++ b/docs/zh/dev/build.md @@ -45,14 +45,14 @@ clice 使用 C++23 作为语言标准 ，请确保有可用的 clang 19 以及 # Linux precompiled binary require glibc 2.35 (build on ubuntu 22.04) $ mkdir -p ./.llvm -$ curl -L "https://github.com/clice-project/llvm-binary/releases/download/20.1.5/x86_64-linux-gnu-release.tar.xz" | tar -xJ -C ./.llvm +$ curl -L "https://github.com/clice-io/llvm-binary/releases/download/20.1.5/x86_64-linux-gnu-release.tar.xz" | tar -xJ -C ./.llvm # MacOS precompiled binary require macos15+ $ mkdir -p ./.llvm -$ curl -L "https://github.com/clice-project/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-release.tar.xz" | tar -xJ -C ./.llvm +$ curl -L "https://github.com/clice-io/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-release.tar.xz" | tar -xJ -C ./.llvm # Windows precompiled binary only MD runtime support -$ curl -O -L "https://github.com/clice-project/llvm-binary/releases/download/20.1.5/x64-windows-msvc-release.7z" +$ curl -O -L "https://github.com/clice-io/llvm-binary/releases/download/20.1.5/x64-windows-msvc-release.7z" $ 7z x x64-windows-msvc-release.7z "-o.llvm" ``` @@ -66,7 +66,7 @@ $ 7z x x64-windows-msvc-release.7z "-o.llvm" 2. 自己从头编译 llvm/clang -这是最推荐的方式，可以保证环境一致性，避免因为 ABI 不一致而导致的崩溃问题。我们提供了一个脚本，用于构建 clice 所需要的 llvm libs：[build-llvm-libs.py](https://github.com/clice-project/clice/blob/main/scripts/build-llvm-libs.py)。 +这是最推荐的方式，可以保证环境一致性，避免因为 ABI 不一致而导致的崩溃问题。我们提供了一个脚本，用于构建 clice 所需要的 llvm libs：[build-llvm-libs.py](https://github.com/clice-io/clice/blob/main/scripts/build-llvm-libs.py)。 ```bash $ cd llvm-project diff --git a/src/Driver/clice.cc b/src/Driver/clice.cc index a1da3a80..f5fdab8b 100644 --- a/src/Driver/clice.cc +++ b/src/Driver/clice.cc @@ -132,7 +132,7 @@ bool checkArguments(int argc, const char** argv) { int main(int argc, const char** argv) { llvm::InitLLVM guard(argc, argv); llvm::setBugReportMsg( - "Please report bugs to https://github.com/clice-project/clice/issues and include the crash backtrace"); + "Please report bugs to https://github.com/clice-io/clice/issues and include the crash backtrace"); if(!checkArguments(argc, argv)) { return 1; diff --git a/xmake.lua b/xmake.lua index 4be6171d..26967e5e 100644 --- a/xmake.lua +++ b/xmake.lua @@ -16,7 +16,7 @@ if has_config("dev") then set_runtimes("MD") if is_mode("debug") then print("Clice does not support build in debug mode with pre-compiled llvm binary on windows.\n" - .."See https://github.com/clice-project/clice/issues/42 for more information.") + .."See https://github.com/clice-io/clice/issues/42 for more information.") os.raise() end elseif is_mode("debug") and is_plat("linux", "macosx") then @@ -189,35 +189,35 @@ package("llvm") else if has_config("release") then if is_plat("windows") then - add_urls("https://github.com/clice-project/llvm-binary/releases/download/$(version)/x64-windows-msvc-release-lto.7z") + add_urls("https://github.com/clice-io/llvm-binary/releases/download/$(version)/x64-windows-msvc-release-lto.7z") add_versions("20.1.5", "0548c0e3f613d1ec853d493870e68c7d424d70442d144fb35b99dc65fc682918") elseif is_plat("linux") then - add_urls("https://github.com/clice-project/llvm-binary/releases/download/$(version)/x86_64-linux-gnu-release-lto.tar.xz") + add_urls("https://github.com/clice-io/llvm-binary/releases/download/$(version)/x86_64-linux-gnu-release-lto.tar.xz") add_versions("20.1.5", "37bc9680df5b766de6367c3c690fe8be993e94955341e63fb5ee6a3132080059") elseif is_plat("macosx") then - add_urls("https://github.com/clice-project/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-release-lto.tar.xz") + add_urls("https://github.com/clice-io/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-release-lto.tar.xz") add_versions("20.1.5", "57a58adcc0a033acd66dbf8ed1f6bcf4f334074149e37bf803fc6bf022d419d2") end else if is_plat("windows") then if is_mode("release", "releasedbg") then - add_urls("https://github.com/clice-project/llvm-binary/releases/download/$(version)/x64-windows-msvc-release.7z") + add_urls("https://github.com/clice-io/llvm-binary/releases/download/$(version)/x64-windows-msvc-release.7z") add_versions("20.1.5", "499b2e1e37c6dcccbc9d538cea5a222b552d599f54bb523adea8594d7837d02b") end elseif is_plat("linux") then if is_mode("debug") then - add_urls("https://github.com/clice-project/llvm-binary/releases/download/$(version)/x86_64-linux-gnu-debug.tar.xz") + add_urls("https://github.com/clice-io/llvm-binary/releases/download/$(version)/x86_64-linux-gnu-debug.tar.xz") add_versions("20.1.5", "c04dddbe1d43d006f1ac52db01ab1776b8686fb8d4a1d13f2e07df37ae1ed47e") elseif is_mode("release") then - add_urls("https://github.com/clice-project/llvm-binary/releases/download/$(version)/x86_64-linux-gnu-release.tar.xz") + add_urls("https://github.com/clice-io/llvm-binary/releases/download/$(version)/x86_64-linux-gnu-release.tar.xz") add_versions("20.1.5", "5ff442434e9c1fbe67c9c2bd13284ef73590aa984bb74bcdfcec4404e5074b70") end elseif is_plat("macosx") then if is_mode("debug") then - add_urls("https://github.com/clice-project/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-debug.tar.xz") + add_urls("https://github.com/clice-io/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-debug.tar.xz") add_versions("20.1.5", "899d15d0678c1099bccb41098355b938d3bb6dd20870763758b70db01b31a709") elseif is_mode("release") then - add_urls("https://github.com/clice-project/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-release.tar.xz") + add_urls("https://github.com/clice-io/llvm-binary/releases/download/20.1.5/arm64-macosx-apple-release.tar.xz") add_versions("20.1.5", "47d89ed747b9946b4677ff902b5889b47d07b5cd92b0daf12db9abc6d284f955") end end