Skip to content

Commit

Permalink
update: README to reflect current release strategy, release.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
winny- committed Sep 7, 2024
1 parent b9f6684 commit 49682f3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
9 changes: 0 additions & 9 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
name: Release
on:
# workflow_run:
# workflows:
# - Build
# branches:
# - master
# types:
# - completed
push:
tags:
- "v*.*.*"
Expand Down Expand Up @@ -186,9 +179,7 @@ jobs:
mv super_rogue_x64.zip super_rogue_windows_x64.zip
- name: Release
uses: softprops/action-gh-release@v2
# if: startsWith(github.ref, 'refs/tags/')
with:
draft: true
files: |
super_rogue.love
Expand Down
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Super Rogue

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)

*(Not [that][original-super-rogue] super rogue!)*

Inspired by [SUPERHOT][superhot].
Expand All @@ -11,11 +13,15 @@ Inspired by [SUPERHOT][superhot].

### Online

This project's default branch deploys to
[super-rogue.workinprogress.top](https://super-rogue.workinprogress.top/).
Each release is automatically published to [bismuthsoft.github.io/super_rogue][web].

[web]: https://bismuthsoft.github.io/super_rogue/

### Pre-built for Linux, Windows

See our [releases page](https://github.com/bismuthsoft/super_rogue/releases) for downloads targeting Windows, Linux, and more!

Each commit is deployed to its own public URL. See comments in PRs or GitHub
Actions transcripts for URLs.
*(Mac users, please consider downloading the `.love` file or playing [the web version][web].)*

### Run natively from source

Expand All @@ -26,13 +32,14 @@ Install [LÖVE (love2d)][love2d]. Then run:
love src
```

Or if you have nix:
Or if you have nix (non-NixOS users need [nixGL][nixGL]):

```bash
nix run .#super_rogue.desktop
```

[love2d]: https://love2d.org/
[nixGL]: https://github.com/nix-community/nixGL

### Run in-browser from source

Expand All @@ -55,7 +62,7 @@ We use a standard GitHub Pull Request workflow.
### Running tests

```bash
run run .#super_rogue.test
nix run .#super_rogue.test
```


Expand Down

0 comments on commit 49682f3

Please sign in to comment.