Skip to content

Commit 5ff758c

Browse files
committed
Remove the redundant summary, and remove the caveat about no MacOS builds since this is no longer true
1 parent ecad1f8 commit 5ff758c

1 file changed

Lines changed: 4 additions & 10 deletions

File tree

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,16 @@
66

77
![GitHub release (with filter)](https://img.shields.io/github/v/release/chadowo/gosu-mruby-wrapper?style=flat-square) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/chadowo/gosu-mruby-wrapper/build.yml?style=flat-square&logo=github) ![GitHub](https://img.shields.io/github/license/chadowo/gosu-mruby-wrapper?style=flat-square)
88

9-
Wrapper around [Gosu](https://www.libgosu.org/) and [MRuby](https://mruby.org/) to run Gosu games natively on desktop platforms.
9+
Wrapper around [Gosu](https://www.libgosu.org/) and [MRuby](https://mruby.org/) (and the [mruby-gosu](https://github.com/cyberarm/mruby-gosu) mgem by Cyberarm)
10+
to run Gosu games natively on desktop platforms.
1011

1112
**NOTE**: This project is really **experimental** and the person behind it (me) isn't
1213
all that great in C, so don't expect that much. having said that feel free
1314
to try it out, and report any problems or things that should be nice to have.
1415

15-
## Summary
16-
17-
This wrapper makes use of MRuby and the [mruby-gosu](https://github.com/cyberarm/mruby-gosu) mgem (by Cyberarm) to create
18-
a simple executable that can run Gosu games easily and painlessly on desktop platforms.
19-
2016
## Building
2117

22-
See instructions for [Windows](https://github.com/Chadowo/gosu-mruby-wrapper/wiki/Compiling-On-Windows) and [Linux](https://github.com/Chadowo/gosu-mruby-wrapper/wiki/Compiling-On-Linux) on the wiki.
18+
See instructions for [Windows](https://github.com/Chadowo/gosu-mruby-wrapper/wiki/Compiling-On-Windows), [MacOS](https://github.com/Chadowo/gosu-mruby-wrapper/wiki/Compiling-On-MacOS) and [Linux](https://github.com/Chadowo/gosu-mruby-wrapper/wiki/Compiling-On-Linux) on the wiki.
2319

2420
## Usage
2521

@@ -28,7 +24,7 @@ wiki page.
2824

2925
## Features
3026

31-
- Targets desktop platforms, like Windows, and Linux.
27+
- Targets desktop platforms, like Windows, MacOS-Intel (**experimental**, contributions appreciated!) and Linux.
3228
**NOTE**: The Windows binary's MRuby is linked with the [UCRT](https://devblogs.microsoft.com/cppblog/introducing-the-universal-crt/) (Universal C Runtime),
3329
the which is bundled by default only on Windows 10 and higher, for older systems
3430
it eithers needs to be installed or provided with the executable.
@@ -37,8 +33,6 @@ wiki page.
3733

3834
## Limitations
3935

40-
- No MacOS builds, this could *definitively* be added, it's just that I don't have a MacOS machine to develop it.
41-
Contributions would be highly appreciated!
4236
- No 32 bit builds, Gosu does support it though, so it's possible.
4337
- No gems, this means that if your game uses CRuby gems it **will not work**.
4438
However you can use gems made in plain Ruby by bundling them with your source code,

0 commit comments

Comments
 (0)