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