README

   1 Command line arguments in C
   2 ===========================
   3
   4 This package provides an example of passing command line arguments
   5 into a C program.
   6
   7 Building
   8 ========
   9
  10 This package contains a simple C program that can be compiled using
  11 the `GNU Compiler Collection`_.  As you write more complicated code
  12 (to solve more complicated problems), you'll be linking to external
  13 libraries and doing other things that make building your software more
  14 complicated.  We record the commands you need to build the software in
  15 the ``Makefile``, which is interpreted by `GNU Make`_ to build the
  16 software.
  17
  18 Compile the program ``args`` with::
  19
  20   $ make
  21
  22 Run the program with::
  23
  24   $ ./make run
  25
  26 Run ``make help`` to get a list of other targets defined in the
  27 ``Makefile``.
  28
  29 reStructuredText
  30 ================
  31
  32 If you're wondering why I keep using backticks and underscores in this
  33 ``README``, it's because I've writing `reStructuredText`_.
  34 reStructedText is a markup syntax that is easy to read, and also easy
  35 to convert to other formats.  However, you can write your ``README``
  36 using any syntax you like, so long as it is easy to understand.
  37
  38 License
  39 =======
  40
  41 This example package is released under the GNU GPLv3+.  See
  42 ``COPYING`` for details.  It's a good idea to distribute your code
  43 under an explicit license so your users will know how they are allowed
  44 to use it.
  45
  46 Contact
  47 =======
  48
  49 W. Trevor King
  50 wking@drexel.edu
  51
  52
  53 .. _GNU Compiler Collection: http://www.gnu.org/software/gcc/
  54 .. _GNU Make: http://www.gnu.org/software/make/
  55 .. _reStructuredText: http://docutils.sourceforge.net/rst.html