diff options
| author | Lamont Granquist <lamont@scriptkiddie.org> | 2015-04-06 18:00:15 -0700 |
|---|---|---|
| committer | Lamont Granquist <lamont@scriptkiddie.org> | 2015-04-06 18:00:15 -0700 |
| commit | 3bd0495de9455fd81fdd843f9eab3cf507f3921a (patch) | |
| tree | b22fc86bc13b6bf860007df6a4c002da5d344b88 /README.md | |
| parent | c7bc67df8d85a0b40b0c6874365e47d541d1884f (diff) | |
| download | ffi-yajl-3bd0495de9455fd81fdd843f9eab3cf507f3921a.tar.gz | |
add note on using system libraries
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 20 insertions, 6 deletions
@@ -36,16 +36,30 @@ could support non-MRI rubies) and we also needed some bug fixes in yajl2, but the maintainer wasn't able to devote enough time to the project to make these updates in a timeframe that worked for us. +## Yajl Library Packaging + +This library prefers to use the embedded yajl 2.x C library packaged in the +libyajl2 gem. In order to use the operating system yajl library (which must be +yajl 2.x) the environment variable `USE_SYSTEM_LIBYAJL2` can be set before +installing or bundling libyajl2. This will force the libyajl2 gem to skip +compiling its embedded library and the ffi-yajl gem will fallback to using the +system yajl library. + ## Thanks -This was initially going to be a clean rewrite of an ffi ruby wrapper around yajl2, but as it progressed more and more code was -pulled in from brianmario's existing yajl-ruby gem, particularly all the c extension code, lots of specs and the benchmarks. And the -process of writing this would have been much more difficult without being able to draw heavily from already solved problems in +This was initially going to be a clean rewrite of an ffi ruby wrapper around +yajl2, but as it progressed more and more code was pulled in from brianmario's +existing yajl-ruby gem, particularly all the c extension code, lots of specs +and the benchmarks. And the process of writing this would have been much more +difficult without being able to draw heavily from already solved problems in yajl-ruby. ## License -Given that this draws heavily from the yajl-ruby sources, and could be considered a derivative work, the MIT License from that -project has been preserved and this source code has deliberately not been dual licensed under Chef's typical Apache License. -See the [LICENSE](https://github.com/chef/ffi-yajl/blob/master/LICENSE) file in this project. +Given that this draws heavily from the yajl-ruby sources, and could be +considered a derivative work, the MIT License from that project has been +preserved and this source code has deliberately not been dual licensed under +Chef's typical Apache License. See the +[LICENSE](https://github.com/chef/ffi-yajl/blob/master/LICENSE) file in this +project. |