Debian Codegraph @

README

raw
1 [![C/C++ CI](https://github.com/ibancg/lingot/workflows/C/C++%20CI/badge.svg)](https://github.com/ibancg/lingot/actions)
2
3 LINGOT - A musical instrument tuner
4 ===================================
5
6 <img align="right" src="http://lingot.nongnu.org/images/lingot-black-main.png">
7
8 LINGOT is a musical instrument tuner. It’s accurate, easy to use, and highly
9 configurable. Originally conceived to tune electric guitars, it can be used to
10 tune other instruments.
11
12 It looks like an analogue tuner, with a gauge or strobe disc indicating the
13 relative shift to a certain note, determined automatically as the closest note
14 to the estimated frequency.
15
16
17 Main features
18 -------------
19
20 * It is free software, distributed under the
21 [GPL license](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html).
22 * Quick and accurate, perfect for real-time microtonal tuning.
23 * Easy to use. Just plug in your instrument and run it.
24 * _LINGOT_ is a universal tuner. It can tune many musical instruments, you only
25 need to provide the scale _temperaments_. For that purpose, it supports the
26 [.scl format](http://www.huygens-fokker.org/scala/scl_format.html) from the
27 [Scala project](http://www.huygens-fokker.org/scala/).
28 * Configurable via GUI. It is possible to change any parameter while the
29 program is running, without editing any file.
30
31 Requirements
32 ------------
33
34 * A modest computer running _GNU/Linux_.
35 * A sound card with line-in or microphone input.
36 * [Jack](http://www.jackaudio.org/),
37 [ALSA](https://www.alsa-project.org/main/index.php/Main_Page),
38 [OSS](http://www.opensound.com/oss.html) or
39 [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) support.
40 * [GTK+](https://www.gtk.org/) library, version _3.10_ or above.
41
42 Installation
43 ------------
44
45 If you are building a release, just type:
46
47 ```console
48 ./configure
49 make install
50 ```
51
52 If you are building a development version obtained from our VCS you will first
53 need to create the _configure_ script, by calling:
54
55 ```console
56 ./bootstrap
57 ```
58
59 The supported audio systems (alsa, oss, jack, pulseaudio) and the Fast Fourier
60 Transform [libfftw](http://fftw.org) library can be enabled/disabled
61 independently via options passed to the `configure` script. The following
62 command displays all options and defaut value.
63
64 ```console
65 ./configure --help
66 ```
67
68 Below a summary of the packages needed to build a development version on
69 _Debian-based_ systems:
70
71 ```console
72 sudo apt-get install \
73 intltool \
74 libasound2-dev \
75 libcunit1-dev \
76 libfftw3-dev \
77 libgtk-3-dev \
78 libjack-jackd2-dev \
79 libjson-c-dev \
80 libpulse-dev \
81 libtool \
82 pkg-config
83 ```
84
85 Beware that LINGOT ships an experimental shared library, whose interface could
86 be subject to change. If you have trouble finding the library when launching the
87 aplication, please consider reporting a bug, and try setting the library path
88 to your installation location as a work-around:
89
90 ```console
91 LD_LIBRARY_PATH=/usr/local/lib lingot
92 ```
93
94 Synopsis
95 --------
96
97 ```console
98 lingot [-c config]
99 ```
100
101 The `-c` option causes the search of a file named `{config}.conf` in the
102 `~/.config/lingot/` folder. For example:
103
104 ```console
105 lingot -c bass
106 ```
107
108 will take the configuration file `~/.config/lingot/bass.conf`. This is useful
109 for maintaining different configurations for different instruments. It's also
110 possible to load and save configuration files from the GUI. The default
111 configuration file is `~/.config/lingot/lingot.conf`.
112
113 Resources
114 ---------
115
116 * [Official LINGOT website](http://lingot.nongnu.org/)
117 * [Project page in Savannah](https://savannah.nongnu.org/projects/lingot/)
118 * [Downloads page in Savannah](http://download.savannah.gnu.org/releases/lingot/)