System behind Japanese Ruby reference manual
Latest commit 1f681b4 Nov 19, 2018

README

BitClust README
===============

About
-----

  BitClust is the Next-Generation Ruby reference manual interface.
  For more details, https://github.com/rurema/doctree/wiki/BitClust .


License
-------

  Ruby License.


Glossary
--------

* "entry" 
  * Each target of documentation.
  * classes: Entry LibraryEntry ClassEntry MethodEntry DocEntry FunctionEntry
* "screen"
  * View class.
  * Used by BitClust server, chm_command, statichtml_command, etc.
* "singleton object" 
  * ARGF, main, etc.
* "BitClust server"
  * HTTP server application to view refenence on browser.
* "Refe server"
  * DRb server spawned by refe --server.
  * Expose BitClust DB via DRuby.