README.md
1[](https://travis-ci.com/gap-packages/intpic)
2[](https://codecov.io/gh/gap-packages/intpic)
3
4IntPic
5======
6
7`IntPic` is a GAP package that provides a simple way of getting a pictorial view of sets of integers.
8
9Introduction
10------------
11
12The aim of the package is to
13help visualising sets of integers and to create publication quality pictures
14of these sets.
15
16There is a manual in the sub-directory `doc` written using the GAP package
17gapdoc which contains several examples illustrating its usage. In particular,
18it is illustrated how the pictures produced (either the tizk code or the
19pictures in pdf) can b eeasily included in a LaTeX document.
20
21If you have used this package, please let me know by sending me an email. If
22you have any suggestion on how to improve it, I would very much appreciate if
23you send me an email.
24
25Manuel Delgado <mdelgado@fc.up.pt>
26
27Contents
28--------
29With this version you should have obtained the following files and
30directories:
31
32| File/directory | Description |
33|:-----|:------|
34|README.md | this file|
35|EXAMPLES| some examples|
36|CHANGELOG| changelog|
37|LICENSE| Licensing information|
38|doc | the manual|
39|gap |the GAP code|
40|tst | a test file|
41|images |images produced using the package and used in the manual|
42|init.g| the file that initializes this package|
43|read.g | the file that reads in the package|
44|PackageInfo.g | information file for automatic processing|
45|version |the version number|
46
47Usage
48-----
49The package shall be distributed with the main GAP archive. In this case, in
50order to use it you just have to start GAP and type
51
52 LoadPackage( "intpic" );
53
54------------------------------
55------------------------------
56For updates between releases of GAP itself or in case it is not distributed
57with the main GAP archive, check the package Web page
58
59 https://gap-packages.github.io/intpic/
60
61For the development version, please visit the repository in GitHub (https://github.com/gap-packages/intpic/)
62
63You may get `IntPic` as a compressed tar archive (file name ends with
64.tar.gz). Use the appropriate command on your system to unpack the
65archive.
66
67On UNIX systems the compressed tar archive may be unpacked by
68
69 tar xzf intpic-<version>.tar.gz
70
71or, if tar on your system does not understand the option z, by
72
73 gunzip intpic-<version>.tar.gz
74 tar xf intpic-<version>.tar
75
76which will in each case unpack the code into a directory `intpic`
77in the current directory. We assume that the current directory is the
78directory /usr/local/lib/gap4r8/pkg/.
79
80Installation
81------------
82
83You may have to start GAP with the -l option, for instance,
84
85 gap -l "/usr/local/lib/gap4r8"
86
87Then try the following
88
89 LoadPackage( "intpic" );
90
91Good luck!
92If the load has been successful the package banner will be shown.
93
94
95If you use a LINUX system, you may want to, in order to save typing, write
96aliases:
97
98in the file `.bash_aliases` (or something equivalent, maybe with another syntax):
99
100 alias gap='gap -l "/usr/local/lib/gap4r8;"'
101
102and in the file `.gap/gaprc`
103
104 LoadPackage( "intpic" );
105
106----------
107
108In other systems, there are equivalent ways to do the same.
109
110
111
112IntPic is free software you can redistribute it and/or modify it
113under the terms of the GNU General Public License as published by the
114Free Software Foundation; either version 2 of the License, or (at your
115option) any later version. For details, see the file `GPL` distributed
116as part of this package or see the FSF's own site.
117
){kind=link}
){kind=link}