README.md in rdoc-markdown-0.2 vs README.md in rdoc-markdown-0.2.1

- old
+ new

@@ -1,10 +1,8 @@ # Rdoc::Markdown -This gem is focused on spitting readable markdown files based on rdoc documentation. It should also come with sqlite database as an index (but this is so far only in plans). +Rdoc Generator plugin to generate markdown documentation and search index as sqlite database that goes along with it. -It is still actively in development and while works as proof of concept, still has some quirks here and there. - ## Installation Install the gem and add to the application's Gemfile by executing: $ bundle add rdoc-markdown @@ -12,19 +10,14 @@ If bundler is not being used to manage dependencies, install the gem by executing: $ gem install rdoc-markdown ## Usage -First thing to do, is to install a gem -`gem install rdoc-markdown` - -Then proceed to directory where you want to generate documentation: - `rdoc --format=markdown` -Don't forget to append `--debug` to have a bit more information in case thing fail (and they will probably do, because this entire thing is experimental). +No additional parameters are currently available, but that may change. ## Development Biggest issue is testing this locally, but that's not as hard to do these days. ``` @@ -39,14 +32,26 @@ ``` gem 'rdoc-markdown`, path: "../rdoc-markdown/` ``` +I have scripted entire process in [rm-reload.sh script](https://github.com/skatkov/gum/blob/master/rm-reload.sh). But it assumes, that you have [gum library](https://github.com/charmbracelet/gum) installed. + +## Testing +Testing is not excessive, just verifies that basic functionality is operational. Following command should run entire testsuit: + +``` +rake test +``` + ## Release ``` gem build rdoc-markdown.gemspec gem push rdoc-markdown-0.1.2.gem ``` + +There is `./publish.sh` script that does that. But it assumes, that you have [gum library](https://github.com/charmbracelet/gum) installed. + ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/skatkov/rdoc-markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/skatkov/rdoc-markdown/blob/master/CODE_OF_CONDUCT.md). ## Code of Conduct