summaryrefslogtreecommitdiffstats
path: root/skeletons/README.erb
blob: e4e3bed2c517cce0a97b57972cae698b24c63a27 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

<%= `figlet -c README` %>
<%# figlet: http://www.figlet.org %>

This is <%= @project %>, version %VERSION%
-----------------------------

<%=@project %> is Copyright (C) <%=@year %>-<%=@year.to_i+5%>, <%= @username %>. <<%= @email %>>

LICENSE INFORMATION
-------------------

<%= license %>

PREREQUISITES
-------------

You'll need a C compiler, a linker and a make program of course.

INSTRUCTIONS
------------

For now, unpack your <%= @project %> tarball, (if you're reading this, you've
probably already done that) and type

    ./configure

If you are self confident you may try the following to have more power on compilation process

    ./configure --help


Next, run make:

You can test <%= @project %> by running

    make test

On some systems you can install <%= @project %>:

    make install

NOTES
-----

CHANGES
-------

For documentation on the user-visible changes between this version and
previous versions, please see CHANGES.

MAILING LISTS
-------------

Subscribe to the mailing list for <%= @project %> by sending mail to
%MAILING_LIST%.

WEB SITES
---------

The home page for <%= @project %> is %HOME_PAGE%