Skip to content

Commit 1e973c7

Browse files
committed
Added build information to the README.
1 parent 3a033f5 commit 1e973c7

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838
### Supported Ruby versions
3939

40-
MRI 1.9.3, 2.0, 2.1, JRuby (1.9 mode), and Rubinius 2.x are supported.
40+
MRI 1.9.3, 2.0, 2.1, 2.2, JRuby (1.9 mode), and Rubinius 2.x are supported.
4141
This gem should be fully compatible with any interpreter that is compliant with Ruby 1.9.3 or newer.
4242

4343
## Features & Documentation
@@ -182,6 +182,33 @@ and load the appropriate C extensions.
182182
No gems should depend on `concurrent-ruby-ext`. Doing so will force C extensions on your users.
183183
The best practice is to depend on `concurrent-ruby` and let users to decide if they want C extensions.
184184

185+
### Building
186+
187+
All published versions of this gem (core, extension, and several platform-specific packages) are compiled,
188+
packaged, tested, and published using an open, [automated process](https://github.com/ruby-concurrency/rake-compiler-dev-box).
189+
This process can also be used to create pre-compiled binaries of the extension gem for virtally
190+
any platform. *Documentation is forthcoming...*
191+
192+
```
193+
*MRI only*
194+
rake build:native # Build concurrent-ruby-ext-<version>-<platform>.gem into the pkg directory
195+
196+
*JRuby only*
197+
rake build # Build JRuby-specific core gem (alias for `build:core`)
198+
rake build:core # Build concurrent-ruby-<version>-java.gem into the pkg directory
199+
200+
*All except JRuby*
201+
rake build # Build core and extension gems
202+
rake build:core # Build concurrent-ruby-<version>.gem into the pkg directory
203+
rake build:ext # Build concurrent-ruby-ext-<version>.gem into the pkg directory
204+
205+
*All*
206+
rake clean # Remove any temporary products
207+
rake clobber # Remove any generated file
208+
rake compile # Compile all the extensions
209+
rake compile:extension # Compile extension
210+
```
211+
185212
## Maintainers
186213

187214
* [Jerry D'Antonio](https://github.com/jdantonio)

0 commit comments

Comments
 (0)