README.GIT 2.83 KB
Newer Older
1
2
INSTRUCTIONS FOR COMPILING AND INSTALLING NANO FROM GIT
=======================================================
Jordi Mallach's avatar
Jordi Mallach committed
3

4
5
The latest changes and fixes for GNU nano are available via git, but
building this needs a bit more care than the official tarballs.
Jordi Mallach's avatar
Jordi Mallach committed
6

7
8
9
10

Prerequisites
-------------

11
To successfully compile GNU nano from git, you'll need the following
12
packages:
Jordi Mallach's avatar
Jordi Mallach committed
13

14
15
- autoconf    (version >= 2.61)
- automake    (version >= 1.7)
16
- autopoint   (version >= 0.11.5)
17
18
19
- gettext     (version >= 0.11.5)
- git         (version >= 2.7.4)
- groff       (version >= 1.12)
20
- pkg-config  (version >= 0.22)
21
- texinfo     (version >= 4.0)
22
23
24
25
- gcc         (any version)
- make        (any version)

If you want UTF-8 support, you will also need libncursesw5-dev installed
26
27
28
(version >= 5.7), or libslang2-dev (version >= 2.0) if you use --with-slang.
If your system doesn't have 'snprintf' or 'vsnprintf' (which the configure
script will check for), you will also need glib-2.x installed.
29
30

These should all be available in your distro's package manager or software
31
center, or otherwise on any GNU mirror.
Jordi Mallach's avatar
Jordi Mallach committed
32

33
34
35
36

Download the source
-------------------

37
38
39
To obtain the current nano development branch (called 'master'), use the
following command.  It will create in your current working directory a
subdirectory called 'nano' containing a copy of all of the files:
40

41
    $ git clone git://git.savannah.gnu.org/nano.git nano
42

David Lawrence Ramsey's avatar
David Lawrence Ramsey committed
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
Generate the configure script
-----------------------------

Once you have the sources in the "nano" directory,

    $ cd nano
    $ ./autogen.sh

This will set up a configure script and a Makefile.in file.


Configure your build
--------------------

To configure your build, run the configure script from the nano source
directory:

    $ ./configure [--add-options-here]


Build and install
-----------------

From the nano source directory, build the code with:

    $ make

71
Then, once it's done compiling, run:
72
73
74

    $ make install

75
which should copy various files (i.e. the nano executable, the info and
76
77
78
79
80
81
man pages, and syntax highlighting pattern files) to their appropriate
directories.

If you're installing into the default install directory (/usr/local),
you'll need to run that "make install" command with root privileges.

82

83
84
Problems?
---------
Jordi Mallach's avatar
Jordi Mallach committed
85

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
Please submit any bugs you find in the code in git via the bug tracker
on Savannah (https://savannah.gnu.org/bugs/?group=nano).


Contributing something
----------------------

If you have a fix for a bug, or the code for a new or improved feature,
first create a branch off of master:

    $ git checkout -b somename

Then change the code so it does what you want, and commit it, with in the
commit message (after the one-line summary) a rationale for the change:

    $ git commit -as

Then create a patch (or patches):

    $ git format-patch master

Send that patch (or patches) to <nano-devel@gnu.org>, as an attachment
or with git send-email.