libusb 1.0.20-rc3
[platform/upstream/libusb.git] / README.git
1 Notes related to git compilation:
2 --------------------------------
3
4 If you retrieved the libusb repository from git and are using a gcc based
5 toolchain, be mindful that you should have the autotools installed (autoconf,
6 automake) and will need to run either ./autogen.sh or ./bootstrap.sh to produce
7 the configure file.
8
9 The difference between autogen.sh and bootstrap.sh is that the former invokes
10 configure with a default set of options, and will therefore generate a Makefile,
11 whereas the latter does not invoke configure at all. If using autogen.sh, note
12 that you can also append options, that will be passed as is to configure.
13
14 OS X-specific notes:
15 -------------------
16
17 Starting with Xcode 4.3, neither Xcode.app nor the Xcode 'command line tools'
18 includes autotools and so running either autogen.sh or bootstrap.sh will result
19 in the message:
20
21 libtoolize or glibtoolize was not found! Please install libtool.
22
23 To proceed, you must find and install it from somewhere.
24
25 Alternatively, you can use the Xcode project at Xcode/libusb.xcodeproj.
26
27 Notes related to submitting new developments:
28 --------------------------------------------
29
30 If you submit a new development to libusb (eg: new backend), that is unlikely
31 to fit in a couple of small patches, we would kindly suggest that you create a
32 public account on github, if you don't have one already, and then fork a new
33 libusb repository under this account from https://github.com/libusb/libusb.
34
35 Then you can create a git branch for your work, that we will be able to better
36 reference and test. 
37
38 We also suggest that, if you are planning to bring in a large development, you
39 try to involve the libusb community early by letting the mailing list know, as
40 you may find that other people might be eager to help you out. 
41 See http://mailing-list.libusb.info for details on how to join the mailing list.