User:Timothee Flutre/Notebook/Postdoc/2012/05/16

From OpenWetWare

< User:Timothee Flutre | Notebook | Postdoc | 2012 | 05(Difference between revisions)
Jump to: navigation, search
(About programming: add python tutorial)
Current revision (13:35, 17 August 2014) (view source)
(About programming: add myreadme.org)
 
Line 22: Line 22:
** '''Bash''': download the file [http://github.com/timflutre/quantgen/blob/master/myprogram.bash myprogram.bash]
** '''Bash''': download the file [http://github.com/timflutre/quantgen/blob/master/myprogram.bash myprogram.bash]
** '''Latex-Beamer''': download the file [http://github.com/timflutre/quantgen/blob/master/myslides.tex myslides.tex]
** '''Latex-Beamer''': download the file [http://github.com/timflutre/quantgen/blob/master/myslides.tex myslides.tex]
 +
** '''org-mode''': download the file [http://github.com/timflutre/quantgen/blob/master/myreadme.org myreadme.org]
* '''Language-independent user documentation''': I'm a firm believer that it is necessary to add some user documentation, even  minimal, to any program. An easy way to do this is to simply generate such documentation from the "help" message, as long as it is "properly" formatted (see [http://www.gnu.org/s/help2man/ help2man]). The following commands work for any programming language:
* '''Language-independent user documentation''': I'm a firm believer that it is necessary to add some user documentation, even  minimal, to any program. An easy way to do this is to simply generate such documentation from the "help" message, as long as it is "properly" formatted (see [http://www.gnu.org/s/help2man/ help2man]). The following commands work for any programming language:

Current revision

Project name Main project page
Previous entry      Next entry

About programming

  • Templates: it is always rewarding on the long term to start any piece of computer software with a minimum amount of generic code (command-line options, help message, license, usage of gzipped files, running time, etc). But it's a pain to write all this every time, right? And often we know how to do something in one language but not in another. So below are my typical templates for any C++/Python/R/Bash program, as well as Beamer presentation.
  • Language-independent user documentation: I'm a firm believer that it is necessary to add some user documentation, even minimal, to any program. An easy way to do this is to simply generate such documentation from the "help" message, as long as it is "properly" formatted (see help2man). The following commands work for any programming language:
help2man -N -o myprogram.man ./myprogram
man ./myprogram.man
groff -mandoc myprogram.man > myprogram.ps
ps2pdf myprogram.ps myprogram.pdf


Personal tools