blackwinter / brice

Extra cool IRb goodness for the masses.

Home Page:http://blackwinter.github.io/brice

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Fix the docs

cdlm opened this issue · comments

  • The readme and RDoc for Brice::Config do not give any examples of available packages
  • what to do with Brice.config.something? e.g. I want to change the colors or the prompt

The readme and RDoc for Brice::Config do not give any examples of available packages

maybe i'll add something to that effect. but i'm not sure yet. if you have any suggestions or even a patch, just let me know. (btw, i'm pretty sure the package files were once included in the docs -- i'm going to investigate this.)

what to do with Brice.config.something? e.g. I want to change the colors or the prompt

the config is mainly used for enabling/disabling packages. not all of them are really configurable that way (yet). again, patches welcome.

to set your own colours or modify the default scheme you can do something like config.colours.opt = { :colours => { ... } } or config.colours.opt = { :colours => Brice::Colours::DEFAULT_COLOURS.merge(...) }.

as for the prompt, just change it after the call to Brice.init (see rc/070_prompt.rb). if you tell me what you might want to configue specifically, i can certainly accommodate that.