Skip to content

Commit

Permalink
website doc add cover image
Browse files Browse the repository at this point in the history
  • Loading branch information
gezhaoyou committed Feb 4, 2024
1 parent 46d2872 commit cca30dd
Show file tree
Hide file tree
Showing 18 changed files with 16 additions and 14 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
> 👏🏻👏🏻 GPUPixel has added support for the `Windows` and `Linux` from [v1.1.0](https://github.com/pixpark/gpupixel/releases/tag/v1.1.0).
> Now it is fully cross-platform supported: `iOS`, `Android`, `Mac`, `Win` and `Linux` 🎉🎉🎉
## Description
## Introduction

⛰️ GPUPixel is a real-time, high-performance image and video filter library, extremely easy to compile and integrate with small library size.

Expand All @@ -44,7 +44,7 @@
## Architecture
![](./docs/image/arch-en.jpg)

## Features Compared
## Features

This table compares the features supported by **GPUPixel** and **GPUImage** and **Android-GPUImage**:

Expand Down Expand Up @@ -102,8 +102,9 @@ This table compares the features supported by **GPUPixel** and **GPUImage** and

![](./docs/image/give-star.gif)

## Quick Start
### 📱 How to Build
## Getting Started

### How to Build
Compile using CMake frome v1.1.0. Please search for instructions on how to install and configure CMake.

The generated libraries and app will be located in the "output" directory of the project's root folder.
Expand Down Expand Up @@ -175,7 +176,7 @@ make
```
---

### 🌵 App demo
### App demo
### iOS
Refer to `examples/ios`
### Mac
Expand All @@ -198,7 +199,7 @@ cmake -G "MinGW Makefiles" ..
# Build
mingw32-make
```
## 🏂 How to Use
## How to Use

**Declear filters**

Expand Down Expand Up @@ -273,17 +274,17 @@ target_raw_output_->setPixelsCallbck([=](const uint8_t *data,
// Output data callbck
```
## 🌠 Star History
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=pixpark/gpupixel&type=Date)](https://star-history.com/#pixpark/gpupixel&Date)
## 🧑‍💻 Contributing
## Contributing
Welcome to contribute code 👏🏻.
At the same time, please consider supporting GPUPixel by sharing it on social media and at events and conferences.
## 👜 Acknowledgement
## Acknowledgement
### Reference Project
1. [GPUImage](https://github.com/BradLarson/GPUImage)
2. [CainCamera](https://github.com/CainKernel/CainCamera)
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default defineConfig({
title: "GPUPixel",
titleTemplate: ':title - GPUPixel',
description: "Cross-Platform AI Beauty Effects Library, Achieving Commercial-Grade Beauty Effects. Written in C++11, Based on OpenGL/ES and VNN.",
head: [['link', { rel: 'icon', href: 'image/favicon/favicon.ico' }]],
head: [['link', { rel: 'icon', href: '/favicon/favicon.ico' }]],

locales: {
root: {
Expand Down Expand Up @@ -47,7 +47,7 @@ export default defineConfig({
},

themeConfig: {
logo: '/image/logo.png',
logo: '/logo.png',
i18nRouting: true,
lastUpdatedText: '最近更新时间',
outline: 'deep',
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ hero:
name: "GPUPixel"
text: "基于GPU 实时 AI 图像美滤镜库"
tagline: 高性能, 跨平台, 达到商业级美颜滤镜效果
# image:
# src: /image/beauty.png
# alt: avatar
image:
src: /cover.svg
alt: cover
actions:
- theme: brand
text: 快速开始
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
1 change: 1 addition & 0 deletions docs/docs/public/cover.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes

0 comments on commit cca30dd

Please sign in to comment.