Add some more documentation on the README, about oui.txt.
[oweals/hwids.git] / README.md
1 Combined hardware identification databases
2 ==========================================
3
4 This repository contain a specially re-packaged copy of the pci.ids
5 and usb.ids files, as well as a copy of IEEE's oui.txt file
6
7 The two IDs databases are maintained by Martin Mares and Michal Vaner
8 (pci.ids) and Stephen J. Gowdy (usb.ids) through the help of
9 volunteers who can submit them to the two submission web applications:
10
11  * [pci.ids](http://pci-ids.ucw.cz/)
12  * [usb.ids](https://usb-ids.gowdy.us/index.html)
13
14 The OUI database is an officially maintained index by IEEE, and can be
15 accessed at https://standards.ieee.org/develop/regauth/oui/public.html .
16
17 The reason to repackage the files together is to make it simpler for
18 applications to require them, without having to bring in either
19 pciutils or usbutils, that might be unnecessary for most installs.
20
21 Updates
22 -------
23
24 The hwids tarball is updated generally on the weekends, and tagged if
25 there are new files available. You can download the tags in form of
26 tarballs directly from [the GitHub
27 repository](https://github.com/Flameeyes/hwids).
28
29 License
30 -------
31
32 The pci.ids and usb.ids files are both released under dual-license,
33 and you can choose which one to apply to your needs. The options are
34 either the GNU General Public License, version 2 or later (which
35 you'll find in the archive, in the file named gpl-2.0.txt), or the
36 3-clause BSD license that follows:
37
38 > Redistribution and use in source and binary forms, with or without
39 > modification, are permitted provided that the following conditions are met:
40 >     * Redistributions of source code must retain the above copyright
41 >       notice, this list of conditions and the following disclaimer.
42 >     * Redistributions in binary form must reproduce the above copyright
43 >       notice, this list of conditions and the following disclaimer in the
44 >       documentation and/or other materials provided with the distribution.
45 >     * Neither the name of the <organization> nor the
46 >       names of its contributors may be used to endorse or promote products
47 >       derived from this software without specific prior written permission.
48 >
49 > THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
50 > ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
51 > WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
52 > DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
53 > DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
54 > (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
55 > LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
56 > ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
57 > (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
58 > SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
59
60 The OUI database is not officially licensed by IEEE, but should be
61 possible to consider it as freely distributable, as a collection of
62 facts.