update readme

This commit is contained in:
maguoqun 2024-10-08 11:20:28 +08:00
parent 1018ee28cf
commit 6a963cf50f
2 changed files with 66 additions and 1 deletions

65
README.md Normal file
View file

@ -0,0 +1,65 @@
# k1x-gpu-test
Demo for users to test GPU.
## Getting started
Clone this Git repository with the following command:
```bash
cd existing_repo
git clone https://gitee.com/bianbu-linux/k1x-gpu-test.git
```
## Usage
Optional test demos:
1. gpu-triangleDemo
2. gpu-squareDemo
3. gpu-textureDemo
4. gpu-cubeDemo
5. gpu-addDemo
To run these executables on your local system, simply type the name of the executable followed by any required arguments. For example, to run gpu-cubeDemo, enter the following command in your terminal:
```bash
gpu-cubeDemo
```
If you are using SSH to log into a remote system and want to run these executables there, you need to set up certain environment variables:
```bash
MESA_LOADER_DRIVER_OVERRIDE=pvr XDG_RUNTIME_DIR=/root WAYLAND_DISPLAY=wayland-1 gpu-cubeDemo
```
## License
BSD 3-Clause License
Copyright (c) 2024, SpacemiT
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

View file

@ -9,7 +9,7 @@ OpenCLOpen Computing Language即开放计算语言最初由苹果公
### 2.1克隆仓库
```git
git clone git@gitlab.dc.com:bianbu/graphics/k1x-gpu-test.git
git clone https://gitee.com/bianbu-linux/k1x-gpu-test.git
```
### 2.2进到源码目录使用cmake进行编译