MESA 81

Martha

Gem that documents code/software for a better organisation and understanding of it by developers.

Table of contents

• Installation
• Usage
• What it actually do?
• Contributing
• Credits
• Issues

Installation

Pre-install:

• Windows Users: Install ruby environment, we recommend RubyInstaller and after install Development Kit and now you can use Ruby's gems.

• Install gems:

  % gem install pry
  

  % gem install nokogiri
  

  Install:

• To install the gem you can just run the following command:

% gem install martha

What it actually do?

Command:

% martha reveal <NAME_FILE>

And your code is documented. Easy

Programming Languages Supported:

• Ruby
• C++

Usage

You only need to use the martha command:

% martha reveal <NAME_FILE>

Issues

• The gem recognizes when a function was commented whit the special characters ("//Function") next to the headers. If you delete this, the function will write a new comment under of the old comment.

Contributing

Everyone is freely to collaborate and submit pull request if needed. You can add more support for new programming languages.

Author and Contributor List

• Victor Hugo Elizalde Muñoz
• Oscar Michel Herrera
• Mauricio Iván Cortés García

Built With

• ruby
• shell