Doc: Fix doxygen warnings and issues
[libusbx.git] / README.git
blob6d7db42a1851825d62269d301cf4981cb4f95281
1 Notes related to git compilation:
2 --------------------------------
4 If you retrieved the libusbx 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.
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.
15 Notes related to submitting new developments:
16 --------------------------------------------
18 If you submit a new development to libusbx (eg: new backend), that is unlikely
19 to fit in a couple of small patches, we would kindly suggest that you create a
20 public account on github, if you don't have one already, and then fork a new
21 libusbx repository under this account from https://github.com/libusbx/libusbx.
23 Then you can create a git branch for your work, that we will be able to better
24 reference and test. 
26 We also suggest that, if you are planning to bring in a large development, you
27 try to involve the libusbx community early by letting the mailing list know, as
28 you may find that other people might be eager to help you out. 
29 See http://mailing-list.libusbx.org for details on how to join the mailing list.