* Indentation cleanup.
[ginac.git] / README
1 General Information
2 ===================
3
4 GiNaC (which stands for "GiNaC is Not a CAS" (computer algebra system)) is a
5 C++ library for symbolic mathematical calculations.  It is designed to allow
6 the creation of integrated systems that embed symbolic manipulations together
7 with more established areas of computer science (like computation-intense
8 numeric applications, graphical interfaces, etc.) under one roof.
9
10 The official ftp site is:
11   ftp://ftpthep.physik.uni-mainz.de/pub/GiNaC/
12
13 The official web site is:
14   http://www.ginac.de/
15
16 A mailing list is located at:
17   ginac-list@ginac.de
18
19 You need to be subscribed to be able to post to the list. To subscribe,
20 please follow the instructions on
21   http://thep.physik.uni-mainz.de/mailman/listinfo/ginac-list
22
23 See http://www.ginac.de/Lists.html for the list policy.
24
25
26 Installation
27 ============
28
29 See the file "INSTALL".
30
31
32 How to report bugs
33 ==================
34
35 If you have identified a bug in GiNaC you are welcome to send a detailed
36 bug report to <ginac-bugs@ginac.de>.  Please think about your bug!  This
37 means that you should include
38
39 * Information about your system
40
41    - Which operating system and version (uname -a)
42    - Which C compiler and version (gcc --version)
43    - For Linux, which version of the C library
44
45   And anything else you think is relevant.
46
47 * Information about your version of GiNaC
48
49    - Version and release number
50    - Which options GiNaC was configured with
51
52 * How to reproduce the bug
53
54    - If it is a systematical bug in the library, a short test program
55      together with the output you get and the output you expect will
56      help us to reproduce it quickly.
57
58 Patches are most welcome.  If possible please make them with diff -c and
59 include ChangeLog entries.