xref: /freebsd/contrib/file/README.DEVELOPER (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1*43a5ec4eSXin LI# How to get started developing
2*43a5ec4eSXin LI
3*43a5ec4eSXin LI@(#) $File: README.DEVELOPER,v 1.9 2021/09/20 14:04:39 christos Exp $
4*43a5ec4eSXin LI
5*43a5ec4eSXin LI## Auto files
6*43a5ec4eSXin LI
7*43a5ec4eSXin LIAfter checking out the source, run the following:
8*43a5ec4eSXin LI
9*43a5ec4eSXin LI	autoreconf -f -i
10*43a5ec4eSXin LI	make distclean	# this can fail if you have not built before
11*43a5ec4eSXin LI	./configure --disable-silent-rules
12*43a5ec4eSXin LI	make -j4
13*43a5ec4eSXin LI	make -C tests check
14*43a5ec4eSXin LI
15*43a5ec4eSXin LIIf you see errors, make sure you have the latest libtool and autoconf
16*43a5ec4eSXin LIThis has been tested with autoconf-2.69 and libtool-2.4.2
17*43a5ec4eSXin LI
18*43a5ec4eSXin LI## Installing dependencies
19*43a5ec4eSXin LI
20*43a5ec4eSXin LIIf your platform doesn't have the above tools, install the following
21*43a5ec4eSXin LIpackages first.
22*43a5ec4eSXin LI
23*43a5ec4eSXin LI### Debian
24*43a5ec4eSXin LI
25*43a5ec4eSXin LI	apt-get install \
26*43a5ec4eSXin LI	    automake \
27*43a5ec4eSXin LI	    gcc \
28*43a5ec4eSXin LI	    libtool \
29*43a5ec4eSXin LI	    make \
30*43a5ec4eSXin LI	    python \
31*43a5ec4eSXin LI	    zlib1g-dev \
32*43a5ec4eSXin LI
33*43a5ec4eSXin LISee also `.travis.yml`.
34*43a5ec4eSXin LI
35*43a5ec4eSXin LI### Mac OS X (MacPorts)
36*43a5ec4eSXin LI
37*43a5ec4eSXin LI	port install \
38*43a5ec4eSXin LI	    autoconf \
39*43a5ec4eSXin LI	    automake \
40*43a5ec4eSXin LI	    libtool \
41*43a5ec4eSXin LI
42*43a5ec4eSXin LI### Mac OS X (HomeBrew)
43*43a5ec4eSXin LI
44*43a5ec4eSXin LI	brew install autoconf automake libtool
45*43a5ec4eSXin LI
46*43a5ec4eSXin LITested with:
47*43a5ec4eSXin LI	autoconf 2.69
48*43a5ec4eSXin LI	automake 1.16.1
49*43a5ec4eSXin LI	libtool 2.4.6
50