Skip to content

Commit

Permalink
Update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
pfeodrippe committed Jul 25, 2024
1 parent 2fc6c3c commit 14b5d69
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 6 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: CI

on: [ push, pull_request ]
on:
push:
branches:
- main

jobs:
build-windows:
Expand Down
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

- TBD

## v0.4.141

- Create github action for Mac, Linux and Windows
- Mac, Linux and Windows packages are now published by Github Actions

## v0.1.98

- Create `vg/start!` as the game wrapper so we can abstract some implementation details
Expand All @@ -20,7 +25,6 @@
- Add JoltPhysicSharp
- Use latest Jolt (support for soft bodies!)
- Support linked GLTF meshes
- Create github action for Mac, Linux and Windows

## v0.1.75

Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@
A Clojure framework for game dev (very WIP, I am still working on a small game
using it).

## Packages

We have a Github Actions pipeline that builds, tests and publishes to Clojars
for each OS, each has a suffix for its version, check below:

- OSX universal (run in M* processors)
- `io.github.pfeodrippe/vybe {:mvn/version "0.4.141-macos-universal"}`
- Linux (x64), tests passing, haven't run it myself, report any issues
- `io.github.pfeodrippe/vybe {:mvn/version "0.4.141-linux-x64"}`
- Windows (x64), tests passing, haven't run it myself, report any issues
- `io.github.pfeodrippe/vybe {:mvn/version "0.4.141-win-x64"}`

## Getting started

Go to <https://github.com/pfeodrippe/vybe-games> and start the REPL for this project using
Expand All @@ -23,10 +35,6 @@ clj -M:osx -m vybe.native.loader && clj -M:osx -m vybe.raylib
clj -M:win -m vybe.native.loader && clj -M:win -m vybe.raylib
```

## Help wanted

If possible, check `bin/jextract-libs.sh` and open a PR to compile to your OS =D

## What does it include?

### `vybe.panama`
Expand Down

0 comments on commit 14b5d69

Please sign in to comment.