blob: d67d3749cc96bb92d7f3e4bb97aa7c6ced223e8e [file] [log] [blame]
Pete Batard873c65b2012-08-01 17:43:33 +01001Notes related to git compilation:
2--------------------------------
3
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +00004If you retrieved the libusb repository from git and are using a gcc based
Pete Batard873c65b2012-08-01 17:43:33 +01005toolchain, be mindful that you should have the autotools installed (autoconf,
6automake) and will need to run either ./autogen.sh or ./bootstrap.sh to produce
7the configure file.
8
9The difference between autogen.sh and bootstrap.sh is that the former invokes
10configure with a default set of options, and will therefore generate a Makefile,
11whereas the latter does not invoke configure at all. If using autogen.sh, note
12that you can also append options, that will be passed as is to configure.
13
Sean McBridea3b92f82012-10-12 15:04:03 -040014OS X-specific notes:
15-------------------
16
17Starting with Xcode 4.3, neither Xcode.app nor the Xcode 'command line tools'
18includes autotools and so running either autogen.sh or bootstrap.sh will result
19in the message:
20
21libtoolize or glibtoolize was not found! Please install libtool.
22
23To proceed, you must find and install it from somewhere.
24
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +000025Alternatively, you can use the Xcode project at Xcode/libusb.xcodeproj.
Pete Batard873c65b2012-08-01 17:43:33 +010026
27Notes related to submitting new developments:
28--------------------------------------------
29
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +000030If you submit a new development to libusb (eg: new backend), that is unlikely
Pete Batard873c65b2012-08-01 17:43:33 +010031to fit in a couple of small patches, we would kindly suggest that you create a
32public account on github, if you don't have one already, and then fork a new
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +000033libusb repository under this account from https://github.com/libusb/libusb.
Pete Batard873c65b2012-08-01 17:43:33 +010034
35Then you can create a git branch for your work, that we will be able to better
Chris Dickens4a5540a2020-03-25 00:09:26 -070036reference and test.
Pete Batard873c65b2012-08-01 17:43:33 +010037
38We also suggest that, if you are planning to bring in a large development, you
hjelmn@cs.unm.edu1eff2202014-01-08 23:50:34 +000039try to involve the libusb community early by letting the mailing list know, as
Chris Dickens4a5540a2020-03-25 00:09:26 -070040you may find that other people might be eager to help you out.
41See http://mailing-list.libusb.info for details on how to join the mailing list.