stuff/INSTALL at master · astromatic/stuff · GitHub

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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
Installing the software
***********************

Hardware requirements
=====================

Stuff runs in (ANSI) text-mode from a shell. A window system is
not necessary for basic operation.

Memory usage is very small (a few tens of Megabytes), even when generating
very large catalogs.

Obtaining Stuff
===============

For Linux users, the simplest way to have Stuff up and running is
to install the standard binary package the comes with your Linux
distribution. Run, e.g., "apt-get Stuff" (on Debian) or "dnf install Stuff"
(Fedora) and Stuff, as well as all its dependencies, will
automatically be installed. If you decided to install the package this
way you may skip the following and move straight to the next section.

However if Stuff is not available in your distribution, or to
obtain the most recent version, the Stuff source package can be
downloaded from the official GitHub repository . One may choose one of
the stable releases, or for the fearless, a copy of the current master
development branch.


Software requirements
=====================

Stuff has been developed on GNU/Linux machines and should compile
on any POSIX-compliant system (this includes Apple OS X and Cygwin
on Microsoft Windows, at the price of some difficulties with the
configuration). No external libraries are required.

Installation
============

To install from the GitHub source package, you must first uncompress
the archive:

   $ unzip stuff-<version>.zip

A new directory called "stuff-<version>" should now appear at the
current location on your disk. Enter the directory and generate the
files required by the autotools, which the package relies on:

   $ cd stuff-<version>
   $ sh autogen.sh

A "configure" script is created. This script has many options, which
may be listed with the "--help" option:

   $ ./configure --help

No options are required for compiling with the default GNU C compiler
("gcc") if all the required libraries are installed at their default
locations:

   $ ./configure

Compared to "gcc", the Intel compiler ("icc") can give the Stuff executable
a strong boost in performance, thanks to better vectorized code. If "icc" is
installed on your system [1], you can take advantage of it using instead

   $ ./configure --enable-icc

Additionally, if the Stuff binary is to be run on a different
machine that does not have "icc" installed (e.g., a cluster computing node),
you must configure a partially statically linked executable using

   $ ./configure --enable-icc --enable-auto-flags --enable-best-link

In all cases, Stuff can now be compiled with

   $ make -j

An "src/stuff" executable is created. For system-wide installation,
run the usual

   $ sudo make install

You may now check that the software is properly installed by simply
typing in your shell:

   $ stuff

(note that some shells require the "rehash" command to be run before
making a freshly installed executable accessible in the execution
path).

[1] The Linux versions of the Intel compiler is  available for free
    to academic researchers, students, educators and open source contributors.