README

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