README.md in ruby_jard-0.2.1 vs README.md in ruby_jard-0.2.2
- old
+ new
@@ -1,23 +1,15 @@
-Jard stands for Just Another Ruby Debugger, aims to provide a better experience while debugging Ruby. Ruby Jard supports the following major features at the moment:
+Jard stands for Just Another Ruby Debugger, aims to provide a better experience while debugging Ruby. Ruby Jard provides modular visual interfaces to show relevant information about your debugging program. Those interfaces are optimized for usability, and highly friendly to developers, especially new comers. They help you reduce the commands you need to type, the mental efforts wasted trying to navigate and grab the information you need. As a result, you can now focus more on the debug flow.
-- Informative Terminal UI, reduce your mental effort for repeated stuff so that you can focus on killing bugs.
-- Highlighted source code screen.
-- Backtrace visualization and navigation.
-- Auto variable display in the current context.
-- Multi-thread exploration and debugging.
-
-Ruby Jard's core is [Byebug](https://github.com/deivid-rodriguez/byebug), an awesome de factor debugger for Ruby. Therefore, Ruby Jard supports most of Byebug's functionalities.
-
-If you still don't know what it is, let's watch this video.
-
[](https://asciinema.org/a/350233)
*[(Click for demo video)](https://asciinema.org/a/350233)*
+Ruby Jard's core is [Byebug](https://github.com/deivid-rodriguez/byebug), an awesome de factor debugger for Ruby. Therefore, Ruby Jard supports most of Byebug's functionalities.
+
## Getting Started
**Warning**: Ruby Jard is still under heavy development. Bugs and weird behaviors are expected. If you see one, please don't hesitate to open an issue. I'll try my best to fix.
Add `ruby_jard` to your Gemfile, recommend to put it in test or development environment.
@@ -108,11 +100,11 @@
**Repl command**: `list`
**Key binding:** F5
-**Alias**: `l`
+**Alias**: `l`, `whereami`
Refresh the whole terminal UI. This command doesn't move you to other steps, nor change any data in your session. It is useful (or the only way) to get back the beautiful UI if you type too much in the REPL console.
### Step
@@ -183,9 +175,39 @@
**Key binding:** None
**Examples**:`frame 10`
Explore a particular frame with id `<frame_id>`. It's faster than `up` and `down`. See `up` command for more information.
+
+## Color schemes
+
+| Name | Screenshots |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `256` <br />Default theme, 256 basic colors, supported by all terminals | <img src="./docs/color_schemes/256.png" style="max-width: 400px;" /> |
+| `deep-space` | <img src="./docs/color_schemes/deep-space.png" style="max-width: 400px;" /> |
+
+
+
+## Configuration
+
+Ruby Jard supports customization via pre-loaded configuration files. You can configure Jard both globally, and per-project.
+
+- The global configuration file is located at `~/.jardrc`.
+- The project configuration file is located at `.jardrc` in working directory when you start Ruby Jard. Per-project ones will override, and merge with global ones.
+
+There are some supported configurations:
+
+| Name | Description | Default |
+| -------------- | ------------------------------------------------------------ | ------- |
+| `color_scheme` | Choose your favorite color scheme. The list of color schemes can be looke up in [Color schemes session](#color-schemes), or from `color-scheme -l` command in REPL. | `256` |
+
+This is a complete example of a configuration file:
+
+```ruby
+config.color_scheme = "deep-space"
+```
+
+## Roadmap
### [Done] Version 0.1.0: Proof of concept
This version is a bootstrap to see whether my idea works or not, in term of technical possibility and user usability. Luckily, everything works now, and I receive possible feedback from friends and peers.