core
/
oga
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation chapter in the README.

This commit is contained in:
Yorick Peterse 2014-09-11 00:11:06 +02:00
parent 5ff7f39f08
commit 9406a8651e
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -86,6 +86,14 @@ gcc or clang. Oga's C extension can be compiled with both. JRuby does not
require a compiler as the native extension is compiled during the Gem building require a compiler as the native extension is compiled during the Gem building
process and bundled inside the Gem itself. process and bundled inside the Gem itself.
## Documentation
The documentation is best viewed [on the documentation website][doc-website].
* {file:contributing Contributing}
* {file:changelog Changelog}
* {file:migrating\_from\_nokogiri Migrating From Nokogiri}
## Native Extension Setup ## Native Extension Setup
The native extensions can be found in `ext/` and are divided into a C and Java The native extensions can be found in `ext/` and are divided into a C and Java
@ -148,3 +156,4 @@ in the root directory of this repository.
[nokogiri]: https://github.com/sparklemotion/nokogiri [nokogiri]: https://github.com/sparklemotion/nokogiri
[oga-wikipedia]: https://en.wikipedia.org/wiki/Japanese_saw#Other_Japanese_saws [oga-wikipedia]: https://en.wikipedia.org/wiki/Japanese_saw#Other_Japanese_saws
[ox]: https://github.com/ohler55/ox [ox]: https://github.com/ohler55/ox
[doc-website]: http://code.yorickpeterse.com/oga/latest/