new readme

This commit is contained in:
2025-12-13 14:41:26 +01:00
parent 8df34776e5
commit a1a1c7ee8f
2 changed files with 3 additions and 48 deletions

View File

@@ -1,50 +1,5 @@
# Development
# Vulkan CTS Viewer
Your new bare-bones project includes minimal organization with a single `main.rs` file and a few assets.
```
project/
├─ assets/ # Any assets that are used by the app should be placed here
├─ src/
│ ├─ main.rs # main.rs is the entry point to your application and currently contains all components for the app
├─ Cargo.toml # The Cargo.toml file defines the dependencies and feature flags for your project
```
### Automatic Tailwind (Dioxus 0.7+)
As of Dioxus 0.7, there no longer is a need to manually install tailwind. Simply `dx serve` and you're good to go!
Automatic tailwind is supported by checking for a file called `tailwind.css` in your app's manifest directory (next to Cargo.toml). To customize the file, use the dioxus.toml:
```toml
[application]
tailwind_input = "my.css"
tailwind_output = "assets/out.css" # also customize the location of the out file!
```
### Tailwind Manual Install
To use tailwind plugins or manually customize tailwind, you can can install the Tailwind CLI and use it directly.
### Tailwind
1. Install npm: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
2. Install the Tailwind CSS CLI: https://tailwindcss.com/docs/installation/tailwind-cli
3. Run the following command in the root of the project to start the Tailwind CSS compiler:
```bash
npx @tailwindcss/cli -i ./input.css -o ./assets/tailwind.css --watch
```
### Serving Your App
Run the following command in the root of your project to start developing with the default platform:
```bash
dx serve
```
To run for a different platform, use the `--platform platform` flag. E.g.
```bash
dx serve --platform desktop
```
A small static website to better view and analyze stats from [deqp-runner](https://gitlab.freedesktop.org/mesa/deqp-runner) results. Result CSV file should be placed in [assets](https://github.com/Kbz-8/VulkanCTSViewer/tree/master/assets) folder before deploying.
![Screenshot](Screenshot.png)

BIN
Screenshot.png git.filemode.normal_file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB