diff --git a/README.en.md b/README.en.md index a015a58ca3ee1a4280948f9554ef377b1d34ef82..abf460b92bf199474560b460d9b2c72b7810e939 100644 --- a/README.en.md +++ b/README.en.md @@ -1,3 +1,125 @@ -# Farris-Vue +

+ + Farris UI Logo + +

+

Farris UI Vue

+ +

Farris UI Vue, a Farris Design based Vue3 component library.

+ +English | [Simplified Chinese](README.md) + +Farris Design Priciples： + +- Fast :Farris UI, composed by UI suites with super-fast user experience. Farris Data Grid, with high-speed rendering performance when rendering huge amounts of data. +- Reliable: Provide users with steady and reliable use embodiment and optimize various abnormal interaction scenarios targeted. +- Responsive: Enhanced responsive design, provides more nuanced responsive interactions inside components. +- Intuitive: Intuitive design, enables users to have an intuitive interface interaction experience. +- Smart : Intelligent UI, meets the development of intelligent application scenarios. + +## 1. Learn about Farris + +Visit our [offical site(https://farris-design.gitee.io/farris-vue)](https://farris-design.gitee.io/farris-vue/) to learn more about Farris UI Vue Components. + +## 2. Guide to Run a Project Locally + +### 2.1 Environment Check + +Please execute the following command to check if `yarn` has been installed in the environment before running the project locally. + +``` +yarn -v +``` + +If you don't know the version information of `yarn`，please refer to [install yarn](https://yarnpkg.com/getting-started/install). + +### 2.2 Get the Source Code + +To get the source code and install dependent components, you can do so by typing: +``` +npm install lerna -g +git clone https://gitee.com/ubml/farris-vue.git +cd farris-vue +lerna bootstrap +``` + +### 2.3 Run Sample Site + +Run the following commands: + +``` +cd packages/ui-vue +yarn run docs:dev +``` + +Open browser to review the sample page：`http://localhost:5173/`。 + +![sample page](./farris_home_page.png) + +### 2.4 Visit Sample Site + +You can visit the sample site： + +1. Click「quick start」to learn how to install and use Farris UI Vue. +2. Click「components」to experience component visual effects and interaction effects, and view the component API documentation simultaneously. + +## 3. Guide to Use Farris UI Vue + +### 3.1 Install @farris/ui-vue + +``` +npm install @farris/ui-vue +``` + +``` +yarn add @farris/ui-vue +``` + +### 3.2 Import Farris UI Vue + +Locate your `main.ts` document and import `@farris/ui-vue` into the Application. + +```ts +import { createApp } from 'vue'; +import App from './App.vue'; +import Farris from '@farris/ui-vue'; + +createApp(App).use(Farris).mount('#app'); +``` + +### 3.3 Use Farris UI Vue + +Once imported, you can attempt to use Farris UI Vue components. Locate to the `App.vue` document and have a try! + +```vue + +``` + +## 4. How to Be a Farris UI Vue Contributor + +Contribute to Farris UI Vue. +You can participate in the following contributions: + +- Develop Farris Vue Components with `TypeScript` + `TSX` + `SystemJs` + `Rollup` technologies +- Contribute to the Farris UI Theme tool +- Contribute to the Farris UI development documentation + +If you decide to contribute to Farris UI Vue，you could start from reading our [Contributor guide](./CONTRIBUTING.md). + +## ✨ Contributors + +Thanks to the following Farris UI Vue contributors. + + + +
+ +## Open source license + +[Apache License 2.0](https://gitee.com/ubml/farris-vue/blob/master/LICENSE) diff --git a/packages/ui-vue/docs/components/button/index.md b/packages/ui-vue/docs/components/button/index.md index c20c9939ad4f415b7e394cfa9dcddec7593aa3b8..fa85659c93b1fa58ac00ea1c166db8a5627d498d 100644 --- a/packages/ui-vue/docs/components/button/index.md +++ b/packages/ui-vue/docs/components/button/index.md @@ -29,20 +29,20 @@ import { ref } from 'vue'; ```vue