ccanlint: add coverage variant of files.
[ccan] / web / staticindex.php
1 <?php
2 session_start();
3 include('logo.html');
4 include('menulist.html');
5 include('static-configuration');
6 ?>
7
8 <h2>The Idea</h2>
9
10 <p>
11 That nice snippets of C code should be moved out of junkcode
12 directories and exposed to a wider world, where they can become
13 something useful.
14 </p>
15
16 <p>
17 CCAN is loosely modelled after the successful <a href="http://cpan.org">CPAN project</a>
18 for Perl code development and sharing.
19 </p>
20
21 <h2>Get The Code</h2>
22
23 <p> You can get each module as a tarball (<a href="list.html">see
24 list</a>), get a tarball of <a href="ccan.tar.bz2">the whole repository</a> with tools,
25 or clone our <a href="http://git.ozlabs.org/?p=ccan">git repository</a> (<tt>git clone git://git.ozlabs.org/~ccan/ccan</tt>).
26 </p>
27
28 <h2>Use The Code</h2>
29 <p>
30 There are two ways to use it:
31 <ol>
32 <li> Put modules into a ccan/ subdirectory into your project.  Add a "config.h" (like
33      <a href="example-config.h">this example</a>, or generate one using <a href="http://git.ozlabs.org/?p=ccan;a=blob_plain;f=tools/configurator/configurator.c">the configurator</a>) and compile every .c file
34      in ccan/* (as in this <a href="Makefile-ccan">Makefile</a>)).
35
36 <li> Alternatively, just hack whatever parts you want so it compiles in
37 your project.
38 </ol>
39 </p>
40
41 <h2>Add Code</h2>
42 <p>
43 We always welcome new code!  Copy an existing module and run the "ccanlint"
44 tool over it, or just send any code you have lying around any let someone
45 else polish it up.
46 </p>
47
48 <p>Anyone can send code or a git pull request to
49 the <a href="http://ozlabs.org/mailman/listinfo/ccan">friendly
50 mailing list</a> or just <a href="upload.html">upload it using the web form</a>.
51 </p>
52
53 <p>
54 "GPLv2 or later" and supersets thereof (eg. LGPLv2+ or BSD)
55 licenses preferred.
56 </p>
57
58 <h2>Complaints, Ideas and Infrastructure</h2>
59
60 <p>
61 We have a <a href="http://ozlabs.org/mailman/listinfo/ccan">low volume
62 mailing list</a> for discussion of CCAN in general, and you're welcome
63 to join.
64 </p>
65
66 <p>
67 We also have an IRC channel: #ccan on <a href="http://freenode.net">Freenode</a>.
68 </p>
69
70 <p>
71 We also have a <a href="Wiki/">wiki</a>; feel free to enhance it.
72 </p>
73 <hr>
74 </body></html>