Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
andyone committed Jun 8, 2024
1 parent 34076fc commit 39273d2
Show file tree
Hide file tree
Showing 4 changed files with 244 additions and 43 deletions.
71 changes: 71 additions & 0 deletions .github/images/mass-builder.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
91 changes: 91 additions & 0 deletions .github/images/rbbuild.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
71 changes: 71 additions & 0 deletions .github/images/rbdef.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 11 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,49 +34,17 @@ sudo make install

### Usage

```
Usage: rbbuild {options} def-file target-dir
Options
--threads, -t num Number of threads for build process
--no-patch, -np Skip patch directives in definition file
--cc-comp, -cc path/name Path to C compiler
--cxx-comp, -cxx path Path to C++ compiler
--ignore-checksums, -ic Skip checksum check
--ignore-loadavg, -il Ignore check for high LA
--mirror, -m name Mirror name for downloading source archives from it
--mirror-list, -L Show list of all available mirrors
--dl-cache, -dc path Path to download cache
--rbenv, -r Automatically install to RBEnv
--name, -rn name Define name of ruby in RBEnv (--rbenv is required)
--proxy, -P url Use HTTP proxy on given host and port
--debug, -D Don't remove build directory and other build data after installation
--output, -O path Output path (default /dev/stdout)
--quiet, -q Quiet mode
--verbose, -V Verbose mode
--tmp, -T path Path to temporary directory (used for unpacking files and build process)
--yes, -y Answer "yes" to all questions
--continue, -C Don't clean prefix directory before build
--no-colors, -nc Don't use colors in output
--no-spinner, -ns Don't show spinner
--help, -h Show this help message
--version, -v Show information about version
Examples
rbbuild 2.7.5 /home/user/ruby-2.7.5 -t 4 -m essentialkaos
Build 2.7.5 with sources from EK mirror using 4 threads
rbbuild 3.0.5 /home/user/ruby-3.0.5
Build 3.0.5 and install it to given directory
rbbuild 3.1.1 -r
Build 3.1.1 and install it to RBEnv
rbbuild 3.1.1 | more
Show def file for 3.1.1
```
#### `rbbuild`

<img src=".github/images/rbbuild.svg" />

#### `rbdef`

<img src=".github/images/rbdef.svg" />

#### `mass-builder`

<img src=".github/images/mass-builder.svg" />

### CI Status

Expand Down

0 comments on commit 39273d2

Please sign in to comment.