You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-2Lines changed: 34 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,14 @@
35
35
</tr>
36
36
</table>
37
37
38
-
## Install
38
+
## Installing and Building
39
+
40
+
This gem includes several platform-specific optimizations. To reduce the possibility of
41
+
compilation errors, we provide pre-compiled gem packages for several platforms as well
42
+
as a pure-Ruby build. Installing the gem should be no different than installing any other
43
+
Rubygems-hosted gem.
44
+
45
+
### Installing
39
46
40
47
```shell
41
48
gem install concurrent-ruby
@@ -49,7 +56,32 @@ gem 'concurrent-ruby'
49
56
50
57
and run `bundle install` from your shell.
51
58
52
-
_NOTE: There is an old gem from 2007 called "concurrent" that does not appear to be under active development. That isn't us. Please do not run*`gem install concurrent`*. It is not the droid you are looking for._
59
+
### Building
60
+
61
+
Because we provide pre-compiled gem builds, users should never need to build the gem manually.
62
+
The build process for this gem is completely automated using open source tools. All of
63
+
the automation components are available in the [ruby-concurrency/rake-compiler-dev-box](https://github.com/ruby-concurrency/rake-compiler-dev-box)
64
+
GitHub repository.
65
+
66
+
This gem will compile native C code under MRI and native Java code under JRuby. It is
67
+
also possible to build a pure-Ruby version. All builds have identical functionality.
68
+
The only difference is performance. Additionally, pure-Ruby classes are always available,
69
+
even when using the native optimizations. Please see the [documentation](http://ruby-concurrency.github.io/concurrent-ruby/)
70
+
for more details.
71
+
72
+
To build and package the gem using MRI or JRuby, install the necessary build dependencies and run:
73
+
74
+
```shell
75
+
bundle exec rake compile
76
+
bundle exec rake build
77
+
```
78
+
79
+
To build and package a pure-Ruby gem, on *any* platform and interpreter
0 commit comments