GitHub - rurema/bitclust: System behind Japanese Ruby reference manual

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 1,179 Commits
.devcontainer		.devcontainer
.github		.github
bin		bin
data/bitclust		data/bitclust
lib		lib
test		test
theme		theme
tools		tools
.gitignore		.gitignore
ChangeLog		ChangeLog
Dockerfile		Dockerfile
Gemfile		Gemfile
README		README
Rakefile		Rakefile
bitclust-core.gemspec		bitclust-core.gemspec
bitclust-dev.gemspec		bitclust-dev.gemspec
compose.yaml		compose.yaml
config.in		config.in
config.ru		config.ru
config.ru.sample		config.ru.sample
packer.rb		packer.rb
refe2.gemspec		refe2.gemspec
server.rb		server.rb
setup.rb		setup.rb
view.cgi		view.cgi

Repository files navigation

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.