|
35 | 35 | </tr>
|
36 | 36 | </table>
|
37 | 37 |
|
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 |
46 |
| - |
47 |
| -```shell |
48 |
| -gem install concurrent-ruby |
49 |
| -``` |
50 |
| - |
51 |
| -or add the following line to Gemfile: |
52 |
| - |
53 |
| -```ruby |
54 |
| -gem 'concurrent-ruby' |
55 |
| -``` |
56 |
| - |
57 |
| -and run `bundle install` from your shell. |
58 |
| - |
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 |
80 |
| -(including MRI and JRuby), run: |
81 |
| - |
82 |
| -```shell |
83 |
| -BUILD_PURE_RUBY='true' bundle exec rake build |
84 |
| -``` |
85 |
| - |
86 | 38 | ## Features & Documentation
|
87 | 39 |
|
88 | 40 | Please see the [Concurrent Ruby Wiki](https://github.com/ruby-concurrency/concurrent-ruby/wiki)
|
@@ -192,6 +144,54 @@ counter.ask(0).class
|
192 | 144 | counter.ask(0).value
|
193 | 145 | ```
|
194 | 146 |
|
| 147 | +## Installing and Building |
| 148 | + |
| 149 | +This gem includes several platform-specific optimizations. To reduce the possibility of |
| 150 | +compilation errors, we provide pre-compiled gem packages for several platforms as well |
| 151 | +as a pure-Ruby build. Installing the gem should be no different than installing any other |
| 152 | +Rubygems-hosted gem. |
| 153 | + |
| 154 | +### Installing |
| 155 | + |
| 156 | +```shell |
| 157 | +gem install concurrent-ruby |
| 158 | +``` |
| 159 | + |
| 160 | +or add the following line to Gemfile: |
| 161 | + |
| 162 | +```ruby |
| 163 | +gem 'concurrent-ruby' |
| 164 | +``` |
| 165 | + |
| 166 | +and run `bundle install` from your shell. |
| 167 | + |
| 168 | +### Building |
| 169 | + |
| 170 | +Because we provide pre-compiled gem builds, users should never need to build the gem manually. |
| 171 | +The build process for this gem is completely automated using open source tools. All of |
| 172 | +the automation components are available in the [ruby-concurrency/rake-compiler-dev-box](https://github.com/ruby-concurrency/rake-compiler-dev-box) |
| 173 | +GitHub repository. |
| 174 | + |
| 175 | +This gem will compile native C code under MRI and native Java code under JRuby. It is |
| 176 | +also possible to build a pure-Ruby version. All builds have identical functionality. |
| 177 | +The only difference is performance. Additionally, pure-Ruby classes are always available, |
| 178 | +even when using the native optimizations. Please see the [documentation](http://ruby-concurrency.github.io/concurrent-ruby/) |
| 179 | +for more details. |
| 180 | + |
| 181 | +To build and package the gem using MRI or JRuby, install the necessary build dependencies and run: |
| 182 | + |
| 183 | +```shell |
| 184 | +bundle exec rake compile |
| 185 | +bundle exec rake build |
| 186 | +``` |
| 187 | + |
| 188 | +To build and package a pure-Ruby gem, on *any* platform and interpreter |
| 189 | +(including MRI and JRuby), run: |
| 190 | + |
| 191 | +```shell |
| 192 | +BUILD_PURE_RUBY='true' bundle exec rake build |
| 193 | +``` |
| 194 | + |
195 | 195 | ## Maintainers
|
196 | 196 |
|
197 | 197 | * [Jerry D'Antonio](https://github.com/jdantonio)
|
|
0 commit comments