<commit_before>= germinate

by <NAME>
    
http://github.com/devver/germinate/

== SYNOPSIS

  germ generate > my_article.rb
  germ format my_article.rb > my_article.txt

== DESCRIPTION

Germinate is a tool for writing about code.  With Germinate, the source code IS
the article.

For example, given the following source code:

  # #!/usr/bin/env ruby
  # :BRACKET_CODE: <pre>, </pre>
  # :PROCESS: ruby, "ruby %f"

  # :SAMPLE: hello
  def hello(who)
    puts "Hello, #{who}"
  end

  hello("World")

  # :TEXT:
  # Check out my amazing program!  Here's the hello method:
  # :INSERT: @hello:/def/../end/

  # And here's the output:
  # :INSERT: @hello|ruby

When we run the <tt>germ format</tt> command the following output is generated:

  Check out my amazing program!  Here's the hello method:
  <pre>
  def hello(who)
    puts "Hello, #{who}"
  end
  </pre>
  And here's the output:
  <pre>
  Hello, World
  </pre>

To get a better idea of how this works, please take a look at
doc/examples/basic.rb[link://doc/examples/basic.rb], or run:

  germ generate > basic.rb

To generate an example article to play with.

Germinate is particularly useful for writing articles, such as blog posts, which
contain code excerpts.  Instead of forcing you to keep a source code file and an<commit_msg>RDoc can be so annoying.<commit_after>= germinate

by <NAME>
    
http://github.com/devver/germinate/

== SYNOPSIS

  germ generate > my_article.rb
  germ format my_article.rb > my_article.txt

== DESCRIPTION

Germinate is a tool for writing about code.  With Germinate, the source code IS
the article.

For example, given the following source code:

  # #!/usr/bin/env ruby
  # :BRACKET_CODE: <pre>, </pre>
  # :PROCESS: ruby, "ruby %f"

  # :SAMPLE: hello
  def hello(who)
    puts "Hello, #{who}"
  end

  hello("World")

  # :TEXT:
  # Check out my amazing program!  Here's the hello method:
  # :INSERT: @hello:/def/../end/

  # And here's the output:
  # :INSERT: @hello|ruby

When we run the <tt>germ format</tt> command the following output is generated:

  Check out my amazing program!  Here's the hello method:
  <pre>
  def hello(who)
    puts "Hello, #{who}"
  end
  </pre>
  And here's the output:
  <pre>
  Hello, World
  </pre>

To get a better idea of how this works, please take a look at
link:doc/examples/basic.rb, or run:

  germ generate > basic.rb

To generate an example article to play with.

Germinate is particularly useful for writing articles, such as blog posts, which
contain code excerpts.  Instead of forcing you to keep a source code file and an
{'fraction_non_alphanumeric': 0.10653188180404355, 'fraction_numerical': 0.0, 'mean_word_length': 3.3536379018612523, 'pattern_counts': {'":': 0, '<': 21, '<?xml version=': 0, '>': 27, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3650710', 'n_tokens_mistral': 891, 'n_tokens_neox': 843, 'n_words': 333}