Started out teaching English at Embry-Riddle.
Graded 10,000 essays.
Lesson learned.
Became a mathematics teacher.
Discovered computing.
Never looked back.
Location
Houston TX
Education
Stetson University: B.A., M.A. in English; M.S. in mathematics
If a README contains example code and/or output, it should be 'rebuilt' before committing. This guards against stale or broken examples.
The rebuild should:
Execute the example code.
Capture and verify the output.
Incorporate the code and output into a rebuilt README via include files.
GitHub Flavored Markdown does not support file inclusion, so I've put up a Ruby gem, markdown_helper, that does support it. File inclusion can be accomplished from the command-line or from within Ruby code.
If a README contains example code and/or output, it should be 'rebuilt' before committing. This guards against stale or broken examples.
The rebuild should:
GitHub Flavored Markdown does not support file inclusion, so I've put up a Ruby gem, markdown_helper, that does support it. File inclusion can be accomplished from the command-line or from within Ruby code.
See the documentation over at GitHub.