From a14d5c3c2275bd6b27c4bec7bc4704b8b8cc9ace Mon Sep 17 00:00:00 2001 From: Piotr Siuszko Date: Mon, 11 Dec 2023 13:36:02 +0100 Subject: [PATCH] New badges, skip builds for commits with README updates --- .github/workflows/itch.yml | 2 ++ .github/workflows/pages.yml | 2 ++ README.md | 43 +++++-------------------------------- 3 files changed, 9 insertions(+), 38 deletions(-) diff --git a/.github/workflows/itch.yml b/.github/workflows/itch.yml index 8668dfe..a8092fc 100644 --- a/.github/workflows/itch.yml +++ b/.github/workflows/itch.yml @@ -6,6 +6,8 @@ on: branches: - main - master + paths-ignore: + - 'README.md' # to only run when you do a new github release, comment out above part and uncomment the below trigger. # on: # release: diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index e8c7d1b..d1176b0 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -6,6 +6,8 @@ on: branches: - main - master + paths-ignore: + - 'README.md' # to only run when you do a new github release, comment out above part and uncomment the below trigger. # on: # release: diff --git a/README.md b/README.md index b51af77..c549f3c 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,12 @@ -# rpack +# rpack [![Build Status](https://github.com/Leinnan/rpack/workflows/CI/badge.svg)](https://github.com/Leinnan/rpack/actions?workflow=CI) + + +[![Itch.io](https://img.shields.io/badge/Itch-%23FF0B34.svg?style=for-the-badge&logo=Itch.io&logoColor=white)](https://mevlyshkin.itch.io/rpack) +[![Github Pages](https://img.shields.io/badge/github%20pages-121013?style=for-the-badge&logo=github&logoColor=white)](http://rpack.mevlyshkin.com/) -[![Build Status](https://github.com/Leinnan/rpack/workflows/CI/badge.svg)](https://github.com/Leinnan/rpack/actions?workflow=CI) Create spritesheets in seconds! Attempt to build texture atlas packer GUI. ![rpack_p9ayUcVnzY](https://github.com/Leinnan/rpack/assets/13188195/289fb455-8ff0-4cbf-8830-b3be773b6a42) - -### Testing locally - -Make sure you are using the latest version of stable rust by running `rustup update`. - -`cargo run --release` - -On Linux you need to first run: - -`sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev` - -On Fedora Rawhide you need to run: - -`dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel` - -### Web Locally - -You can compile your app to [WASM](https://en.wikipedia.org/wiki/WebAssembly) and publish it as a web page. - -We use [Trunk](https://trunkrs.dev/) to build for web target. -1. Install the required target with `rustup target add wasm32-unknown-unknown`. -2. Install Trunk with `cargo install --locked trunk`. -3. Run `trunk serve` to build and serve on `http://127.0.0.1:8080`. Trunk will rebuild automatically if you edit the project. -4. Open `http://127.0.0.1:8080/index.html#dev` in a browser. See the warning below. - -> `assets/sw.js` script will try to cache our app, and loads the cached version when it cannot connect to server allowing your app to work offline (like PWA). -> appending `#dev` to `index.html` will skip this caching, allowing us to load the latest builds during development. - -### Web Deploy -1. Just run `trunk build --release`. -2. It will generate a `dist` directory as a "static html" website -3. Upload the `dist` directory to any of the numerous free hosting websites including [GitHub Pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). -4. we already provide a workflow that auto-deploys our app to GitHub pages if you enable it. -> To enable Github Pages, you need to go to Repository -> Settings -> Pages -> Source -> set to `gh-pages` branch and `/` (root). -> -> If `gh-pages` is not available in `Source`, just create and push a branch called `gh-pages` and it should be available.