Skip to content

Commit 7e9d67f

Browse files
authored
update readme
[ci skip]
1 parent 98ddae1 commit 7e9d67f

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# ocran
22

33
home :: https://github.com/largo/ocran/
4-
54
issues :: https://github.com/largo/ocran/issues
65

76
## Description
@@ -23,18 +22,19 @@ Ruby 3.2+ compatibility.
2322

2423
## Recommended usage
2524

26-
The most common use-case is shipping a program to Windows servers or users
27-
who do not have Ruby installed. By default, each time the `.exe` is opened it
25+
The most common use-case is shipping a program to users running Windows / Linux / macOS
26+
who do not have Ruby installed. By default, each time the `.exe` / executable is opened it
2827
extracts the Ruby interpreter and your code to a temporary directory and runs
2928
them from there.
3029

31-
Because extraction takes time on each launch, consider using the Inno Setup
30+
Because extraction takes time on each launch, use `--output-dir` or
31+
`--output-zip` to produce a portable directory/archive that runs with the
32+
bundled Ruby on Linux, macOS, or Windows.
33+
If using Windows you can use the Inno Setup
3234
option (`--innosetup`) to produce a proper installer that extracts once to a
3335
permanent directory.
3436

35-
For cross-platform packaging or CI artifacts, use `--output-dir` or
36-
`--output-zip` to produce a portable directory/archive that runs with the
37-
bundled Ruby on Linux, macOS, or Windows.
37+
You can easily generate binaries for the supported Operating Systems with GitHub Actions.
3838

3939
## Features
4040

@@ -74,12 +74,12 @@ https://github.com/largo/ocran/releases/.
7474

7575
## Synopsis
7676

77-
### Building a Windows executable:
77+
### Building an executable:
7878

7979
ocran script.rb
8080

8181
Packages `script.rb`, the Ruby interpreter, and all dependencies (gems and
82-
DLLs) into `script.exe`.
82+
DLLs) into `script.exe` or `script` on Linux or macOS.
8383

8484
### Building a portable directory (Linux / macOS / Windows):
8585

@@ -243,7 +243,8 @@ a Linux runner for Linux builds).
243243
## Requirements
244244

245245
* Ruby 3.2+
246-
* For building Windows `.exe`: Windows with RubyInstaller DevKit (mingw-w64), or Wine on Linux/macOS
246+
* For building Windows `.exe`: Windows with [RubyInstaller DevKit](https://rubyinstaller.org/downloads/) (mingw-w64), or Wine on Linux/macOS
247+
* For building Linux and MacOS binaries: the respective build tools
247248
* For `--output-dir` / `--output-zip`: any platform with Ruby 3.2+
248249
* For `--output-zip` on Linux/macOS: the `zip` command must be available
249250
* For `--output-zip` on Windows: PowerShell (included in Windows 8+)
@@ -526,6 +527,11 @@ file:
526527
end
527528
end
528529

530+
## See elsewhere
531+
532+
- [State of Ruby Packagers](https://gist.github.com/YOU54F/3775e66e6090e0371c11601e6b75c305)
533+
- [Traveling Ruby](https://github.com/trubygems/traveling-ruby)
534+
529535
## Credits
530536

531537
Lars Christensen and contributors for the OCRA project which this is forked from.

0 commit comments

Comments
 (0)