try to cleanup the mess in the input code
[pcsx_rearmed.git] / deps / lightning / README-hacking
CommitLineData
519a9ea1
PC
1This README-hacking file describes the development environment.
2
3Everything related to the development of GNU lightning is on Savannah:
4https://savannah.gnu.org/projects/lightning/.
5
6
7* Working from the Repository
8
9** Autotools
10
11This distribution uses the latest stable versions of Automake, Autoconf. If
12you are getting the sources from git (or change configure.ac), you'll need
13to have these tools installed to (re)build. All
14of these programs are available from ftp://ftp.gnu.org/gnu.
15
16If you're using a GNU/Linux distribution, the easiest way to install these
17packages depends on your system. The following shell command should work
18for Debian-based systems such as Ubuntu:
19
20 $ sudo apt-get install autoconf automake
21
22
23** Building
24
40a44dcb
PC
25If you intend to do development work with lightning, it's useful to build
26lightning with its disassembler feature enabled. This optional feature
27requires additional dependencies. On Ubuntu, this command should work:
28
29 $ sudo apt-get install binutils-dev libiberty-dev zlib1g-dev
30
519a9ea1
PC
31After getting the git sources, and installing the tools above, you can run
32
33 $ ./bootstrap
34 $ ./configure
35 $ make
36 $ make check
37
38to do a fresh build. At this point, there should be no difference between
39your local copy, and the master copy:
40
41 $ git diff
42
43should output no difference.
44
45After that first time, running make should suffice.
46
40a44dcb
PC
47To install lightning:
48
49 $ sudo make install
50
519a9ea1
PC
51** Gnulib
52
53This distribution also uses Gnulib (https://www.gnu.org/software/gnulib) to
54share common files, stored as a submodule in git.
55
56** Updating
57
58 $ git pull
59 $ git submodule update
60
61** Updating a submodule
62
63To update a submodule, say gnulib, do as follows:
64
65Get the most recent version of the master branch from git.
66
67 $ cd gnulib
68 $ git pull
69
70Make sure GNU lightning can live with that version of gnulib.
71
72 $ cd ..
73 $ ./bootstrap
74 $ make distcheck
75
76Register your changes.
77
78 $ git commit ...
79
80
81----
82
83
84Copyright 2021 Free Software Foundation, Inc.
85
86This file is part of GNU lightning.
87
88GNU lightning is free software; you can redistribute it and/or modify
89it under the terms of the GNU Lesser General Public License as
90published by the Free Software Foundation; either version 3, or (at
91your option) any later version.
92
93GNU lightning is distributed in the hope that it will be useful, but
94WITHOUT ANY WARRANTY; without even the implied warranty of
95MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
96Lesser General Public License for more details.
97
98You should have received a copy of the GNU Lesser General Public
99License along with this program. If not, see
100<http://www.gnu.org/licenses/>.
101
102
103Local Variables:
104mode: outline
105fill-column: 76
106End: