|
Notes on Makefile and More - CSCI 531, Spring 2013 |
||
|
You are suppose to know how to write a Makefile already. If you don't, you should learn it as soon as possible because your Makefile must work in all your project submissions. There are a few tutorials on make on the web. Here are links to some of them. I have not really read through these pages so I cannot guarantee their correctness. |
||
| Windows Makefiles | ||
| Please be aware that if you transfer a Makefile from a Windows environment to a UNIX environment, chances are, it will not work. The reason is that a line in a text file in Windows ends with "\r\n" while a line in a text file in UNIX ends with just "\n". The extra "\r" can confuse make on UNIX machines. But I'm sure you can write a small program to fix that. | ||
| Compiling Your Code | ||
| If you are writing your program in C, you should use gcc as your compiler, rather than cc. Gcc supports function prototypes and other ANSI extensions, which you should use in your programs. The option -Wall turns on most of the useful gcc/g++ warnings. Compiling with this option will find many simple mistakes in your programs. On many platforms you also need to link the network and socket libraries to your program. | ||
| Compilation Requirements | ||
We will evaluate your submission by copying all the files you have
submitted into an empty directory and then type the following command:
make
(If an individual project spec has more specific way of producing
executables, you must follow it.)
Minor variation (such as using gmake) is allowed, but you must
describe in details how to compile your code near the top of
your README file. Requiring a visual tool to compile your code
is not allowed.
If this does not produce the desired executable(s), you will
probably lose a lot of points.
You may lose quite a few points if the grader has to debug and
modify your Makefile in order to get your code to compile.
How many points you will lose depends on
how hard it is for the grader to get your Makefile to work.
You may even receive a score of zero if we cannot get your Makefile
to work.
Here are some additional requirements:
|
||
| README Requirements | ||
The README file you submit should include the following:
|
||
| Citation Requirements | ||
|
For programming assignments where you are permitted to use
code fragments obtained from public sources (or code
derived or adapted from them), you must explicitly cite
from where you obtained the code, and you must use the
correct procedure to cite your source.
You must read the licensing terms of the public code carefully before you start using the code. You must comply with the licensing terms of the code if you decide to use it in your assignment. If the licensing terms of the code says that you must include certain copyright notice in your code, you must do so. If you are only copying some functionalities from a public source, as soon as you have copied them into your code, do the following immediately. Surround the downloaded code with a comment above and a comment below. The comment above should say something like the following (please adapt it for your case):
/*
* Begin code I did not write.
* The following code was obtained from <URL>...
* [ copyright so and so, if required ... ]
*/
The comment below should say:
/*
* End code I did not write.
*/
With this declaration, you would be saying that you wrote
everything else yourself.
Although it's a good idea to summarize what code you have used in your README file, just saying that I use code from this and that URL in your README file is not an acceptable way of giving citation. You must also cite your source using the method described above. |
||
| Additional Hints | ||
How do you make sure that make would work? It's actually
very simple.
|
||