From 1e027101d3ca38ebf015078bf8580147d6e19ebf Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Mon, 11 Feb 2013 09:58:35 -0500 Subject: [PATCH] README: Specialize for assignment 4 --- README | 36 +++++++++++------------------------- 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/README b/README index 9ee091b..e63b768 100644 --- a/README +++ b/README @@ -1,48 +1,35 @@ -Homework 0 -========== +Assignment 4 +============ -This package provides an example of simple packaging for a C or C++ -program. This will give you an idea of what I expect when you submit -homework assignments. +This package solves `assignment 4 for physics 305`__ (see ``hw4.txt`` +for a plain-text version), plotting the Mandelbrot set. + +__ http://physics.drexel.edu/~valliere/PHYS305/phys305.w13/assignments/hw4/hw4.pdf Building ======== -This package contains a simple C or C++ program that can be compiled -using the `GNU Compiler Collection`_. As you write more complicated -code (to solve more complicated problems), you'll be linking to -external libraries and doing other things that make building your -software more complicated. We record the commands you need to build +This package contains a few C programs that can be compiled using the +`GNU Compiler Collection`_. We record the commands you need to build the software in the ``Makefile``, which is interpreted by `GNU Make`_ to build the software. -Compile the programs ``hello_world`` and ``goodbye_world`` with:: +Compile the programs with:: $ make -Run the program with:: +Run the programs with:: $ ./make run Run ``make help`` to get a list of other targets defined in the ``Makefile``. -reStructuredText -================ - -If you're wondering why I keep using backticks and underscores in this -``README``, it's because I've writing `reStructuredText`_. -reStructedText is a markup syntax that is easy to read, and also easy -to convert to other formats. However, you can write your ``README`` -using any syntax you like, so long as it is easy to understand. - License ======= This example package is released under the GNU GPLv3+. See -``COPYING`` for details. It's a good idea to distribute your code -under an explicit license so your users will know how they are allowed -to use it. +``COPYING`` for details. Contact ======= @@ -53,4 +40,3 @@ wking@drexel.edu .. _GNU Compiler Collection: http://www.gnu.org/software/gcc/ .. _GNU Make: http://www.gnu.org/software/make/ -.. _reStructuredText: http://docutils.sourceforge.net/rst.html -- 2.26.2