]> www.ginac.de Git - ginac.git/blob - README
documentation update
[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 To subscribe, send an email to majordomo@ginac.de containing the line
20
21   subscribe ginac-list your-name@your.domain
22
23 in the body of your email. You will then receive an email containing
24 instructions how to confirm your subscription.
25
26 See http://www.ginac.de/Lists.html for the list policy.
27
28
29 Installation
30 ============
31
32 See the file "INSTALL".
33
34
35 How to report bugs
36 ==================
37
38 If you have identified a bug in GiNaC you are welcome to send a detailed
39 bug report to <ginac-bugs@ginac.de>.  Please think about your bug!  This
40 means that you should include
41
42 * Information about your system
43
44    - Which operating system and version (uname -a)
45    - Which C compiler and version (gcc --version)
46    - For Linux, which version of the C library
47
48   And anything else you think is relevant.
49
50 * Information about your version of GiNaC
51
52    - Version and release number
53    - Which options GiNaC was configured with
54
55 * How to reproduce the bug
56
57    - If it is a systematical bug in the library, a short test program
58      together with the output you get and the output you expect will
59      help us to reproduce it quickly.
60
61 Patches are most welcome.  If possible please make them with diff -c and
62 include ChangeLog entries.