diff --git a/README.md b/README.md index 7c7e8ef..3a7af9d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,22 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/creativetimofficial/ui) · [上游 README](https://github.com/creativetimofficial/ui/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + [![Creative Tim UI](https://raw.githubusercontent.com/creativetimofficial/ui/refs/heads/main/apps/www/public/opengraph-image.png)](https://creative-tim.com/ui) # Creative Tim UI -[Creative Tim UI](https://creative-tim.com/ui) is a comprehensive component library built on top of [shadcn/ui](https://ui.shadcn.com/) to help you build modern web applications faster. +[Creative Tim UI](https://creative-tim.com/ui) 是一个基于 [shadcn/ui](https://ui.shadcn.com/) 构建的综合性组件库,可帮助你更快地开发现代 Web 应用。 -## Overview +## 概述 -Creative Tim UI provides pre-built, customizable React components and blocks designed for building beautiful, production-ready web applications. -The CLI makes it easy to add these components to your Next.js project. +Creative Tim UI 提供预构建、可定制的 React 组件与区块,专为构建美观且可用于生产环境的 Web 应用而设计。 +CLI 可让你轻松将这些组件添加到你的 Next.js 项目中。 -## Installation -You can use the Creative Tim UI CLI directly with npx, or install it globally: +## 安装 +你可以直接使用 npx 运行 Creative Tim UI CLI,或进行全局安装: ```bash # Use directly (recommended) npx @creative-tim/ui@latest add @@ -19,37 +25,37 @@ npx @creative-tim/ui@latest add npx shadcn@latest add https://creative-tim.com/ui/r/all.json ``` -## Prerequisites -Before using Creative Tim UI, ensure your Next.js project meets these requirements: -- **Node.js 18** or later -- **shadcn/ui** initialized in your project (npx shadcn@latest init) -- **Tailwind CSS** configured +## 前置要求 +在使用 Creative Tim UI 之前,请确保你的 Next.js 项目满足以下要求: +- **Node.js 18** 或更高版本 +- 项目中已初始化 **shadcn/ui**(npx shadcn@latest init) +- 已配置 **Tailwind CSS** -## Usage +## 使用 -### Install All Components -Install all available Creative Tim UI components at once: +### 安装全部组件 +一次性安装所有可用的 Creative Tim UI 组件: ```bash npx @creative-tim/ui@latest add all ``` -This command will: -- Set up shadcn/ui if not already configured -- Install all Creative Tim UI components to your configured components directory -- Add necessary dependencies to your project +该命令将: +- 若尚未配置,则设置 shadcn/ui +- 将所有 Creative Tim UI 组件安装到你配置的组件目录 +- 向项目添加必要的依赖 -### Install Specific Components -Install individual components using the `components add` command: +### 安装指定组件 +使用 `components add` 命令安装单个组件: ```bash npx @creative-tim/ui@latest add ``` -Examples: +示例: ```bash # Install the orb component npx @creative-tim/ui@latest add card ``` -### Alternative: Use with shadcn CLI -You can also install components using the standard shadcn/ui CLI: +### 备选方案:使用 shadcn CLI +你也可以使用标准的 shadcn/ui CLI 安装组件: ```bash # Install all components npx shadcn@latest add https://creative-tim.com/ui/r/all.json @@ -58,13 +64,13 @@ npx shadcn@latest add https://creative-tim.com/ui/r/all.json npx shadcn@latest add https://creative-tim.com/ui/r/button.json ``` -All available components can be found [here](https://creative-tim.com/ui/docs/components) or explore a list of example blocks [here](https://creative-tim.com/ui/blocks). +所有可用组件可在[此处](https://creative-tim.com/ui/docs/components) 查看,也可在[此处](https://creative-tim.com/ui/blocks). 浏览示例区块列表。 -## Blocks +## 区块 -Explore our collection of ready-to-use blocks organized by category. Each block is fully customizable and can be added to your project with a single command. +浏览我们按类别整理的即用型区块集合。每个区块均可完全自定义,并可通过一条命令添加到你的项目中。 -### Application UI +### 应用 UI @@ -95,7 +101,7 @@ Explore our collection of ready-to-use blocks organized by category. Each block
-### Marketing +### 营销 @@ -144,8 +150,8 @@ Explore our collection of ready-to-use blocks organized by category. Each block
-### Ecommerce UI -Ready-to-use blocks for product listings, shopping carts, and checkout flows. +### 电商 UI +适用于产品列表、购物车和结账流程的即用型区块。 @@ -161,7 +167,7 @@ Ready-to-use blocks for product listings, shopping carts, and checkout flows.
### Web 3.0 -Innovative sections built for decentralized applications, blockchain projects, and crypto platforms. +为去中心化应用、区块链项目和加密货币平台打造的创新区块。 @@ -176,30 +182,30 @@ Innovative sections built for decentralized applications, blockchain projects, a
-## Contributing +## 贡献 -If you'd like to contribute to Creative Tim UI, please follow these steps: +如果你想为 Creative Tim UI 做出贡献,请按以下步骤操作: -1. Fork the repository -2. Create a new branch -3. Make your changes to the components in the registry. -4. Open a PR to the main branch. +1. Fork 该仓库 +2. 创建新分支 +3. 在 registry 中修改组件。 +4. 向 main 分支提交 PR。 -Please read the [contributing guide](/CONTRIBUTING.md). +请阅读[贡献指南](/CONTRIBUTING.md)。 -## Copyrights and Licenses +## 版权与许可 -Creative Tim UI is built upon the incredible work of the open source community: +Creative Tim UI 建立在开源社区卓越工作的基础之上: -- **[shadcn/ui](https://ui.shadcn.com/)** - The documentation structure, registry system, and foundational (atomic) components are from the open source work in shadcn/ui. [MIT License](https://github.com/shadcn-ui/ui/blob/main/LICENSE.md) -- **[Material Tailwind](https://material-tailwind.com/v3)** by Creative Tim - The blocks and component designs are inspired by and based on Material Tailwind Framework. [MIT License](https://github.com/creativetimofficial/material-tailwind/blob/main/LICENSE.md) -- **[Eleven Labs UI](https://github.com/elevenlabs/elevenlabs-ui)** - General inspiration for the documentation structure and approach of blocks. [MIT License](https://github.com/elevenlabs/ui/blob/main/LICENSE.md) -- **[Geist Font](https://vercel.com/font)** by Vercel - The beautiful typeface used throughout the interface. [SIL Open Font License 1.1](https://github.com/vercel/geist-font/blob/main/LICENSE.txt) +- **[shadcn/ui](https://ui.shadcn.com/)** - 文档结构、registry 系统以及基础(原子)组件均来自 shadcn/ui 的开源工作。[MIT License](https://github.com/shadcn-ui/ui/blob/main/LICENSE.md) +- **[Material Tailwind](https://material-tailwind.com/v3)** by Creative Tim - 区块与组件设计受 Material Tailwind Framework 启发并以其为基础。[MIT License](https://github.com/creativetimofficial/material-tailwind/blob/main/LICENSE.md) +- **[Eleven Labs UI](https://github.com/elevenlabs/elevenlabs-ui)** - 文档结构与区块设计思路的总体灵感来源。[MIT License](https://github.com/elevenlabs/ui/blob/main/LICENSE.md) +- **[Geist Font](https://vercel.com/font)** by Vercel - 界面中使用的优美字体。[SIL Open Font License 1.1](https://github.com/vercel/geist-font/blob/main/LICENSE.txt) -We are grateful to these projects for making their work available under open source licenses. +我们感谢这些项目在开源许可下公开其工作成果。 -## License +## 许可证 -Licensed under the [MIT license](https://github.com/creativetimofficial/ui/blob/main/LICENSE.md). +根据 [MIT license](https://github.com/creativetimofficial/ui/blob/main/LICENSE.md). 授权。 -Made with love by [Creative Tim](https://creative-tim.com). +由 [Creative Tim](https://creative-tim.com). 倾心打造