1414
1515## Intro
1616
17- For various reasons you may need to build HIDAPI on your own.
17+ For various reasons, you may need to build HIDAPI on your own.
1818
1919It can be done in several different ways:
2020- using [ CMake] ( BUILD.cmake.md ) ;
2121- using [ Autotools] ( BUILD.autotools.md ) (deprecated);
2222- using [ manual makefiles] ( #building-the-manual-way-on-unix-platforms ) ;
2323- using ` Meson ` (requires CMake);
2424
25- ** Autotools** build system is historically first mature build system for
26- HIDAPI. Most common usage of it is in its separate README: [ BUILD.autotools.md] ( BUILD.autotools.md ) .<br />
25+ ** Autotools** build system is historically the first mature build system for
26+ HIDAPI. The most common usage of it is in its separate README: [ BUILD.autotools.md] ( BUILD.autotools.md ) .<br />
2727NOTE: for all intentions and purposes the Autotools build scripts for HIDAPI are _ deprecated_ and going to be obsolete in the future.
2828HIDAPI Team recommends using CMake build for HIDAPI.
2929
3030** CMake** build system is de facto an industry standard for many open-source and proprietary projects and solutions.
31- HIDAPI is one of the projects which uses the power of CMake for its advantage.
31+ HIDAPI is one of the projects which use the power of CMake to its advantage.
3232More documentation is available in its separate README: [ BUILD.cmake.md] ( BUILD.cmake.md ) .
3333
3434** Meson** build system for HIDAPI is designed as a [ wrapper] ( https://mesonbuild.com/CMake-module.html ) over CMake build script.
@@ -40,12 +40,12 @@ If you don't know where to start to build HIDAPI, we recommend starting with [CM
4040
4141## Prerequisites:
4242
43- Regardless of what build system system you choose to use, there are specific dependencies for each platform/backend.
43+ Regardless of what build system you choose to use, there are specific dependencies for each platform/backend.
4444
4545### Linux:
4646
4747Depending on which backend you're going to build, you'll need to install
48- additional development packages. For ` linux/hidraw ` backend you need
48+ additional development packages. For ` linux/hidraw ` backend, you need a
4949development package for ` libudev ` . For ` libusb ` backend, naturally, you need
5050` libusb ` development package.
5151
@@ -59,19 +59,19 @@ sudo apt install libusb-1.0-0-dev
5959
6060### FreeBSD:
6161
62- On FreeBSD you will need to install libiconv. This is done by running
62+ On FreeBSD, you will need to install libiconv. This is done by running
6363the following:
6464``` sh
6565pkg_add -r libiconv
6666```
6767
6868### Mac:
6969
70- On Mac make sure you have XCode installed and its Command Line Tools.
70+ Make sure you have XCode installed and its Command Line Tools.
7171
7272### Windows:
7373
74- On Windows you just need a compiler. You may use Visual Studio or Cygwin/MinGW,
74+ You just need a compiler. You may use Visual Studio or Cygwin/MinGW,
7575depending on which environment is best for your needs.
7676
7777## Embedding HIDAPI directly into your source tree
@@ -95,7 +95,7 @@ depending on your platform and the backend you want to use:
9595- make the platform/backend specific [ dependencies] ( #prerequisites ) available during the compilation/linking, when building ` hid.c ` ;
9696
9797NOTE: the above doesn't guarantee that having a copy of ` <backend>/hid.c ` and ` hidapi/hidapi.h ` is enough to build HIDAPI.
98- The only guarantee that ` <backend>/hid.c ` includes all nesessary sources to compile it as a single file.
98+ The only guarantee that ` <backend>/hid.c ` includes all necessary sources to compile it as a single file.
9999
100100Check the manual makefiles for a simple example/reference of what are the dependencies of each specific backend.
101101
@@ -106,7 +106,7 @@ to build a program which embeds HIDAPI directly inside of it. These should
106106really be used as examples only. If you want to build a system-wide shared
107107library, use one of the build systems mentioned above.
108108
109- To build HIDAPI using the manual Makefiles, change to the directory
109+ To build HIDAPI using the manual Makefiles, change the directory
110110of your platform and run make. For example, on Linux run:
111111``` sh
112112cd linux/
@@ -118,7 +118,7 @@ make -f Makefile-manual
118118To build the HIDAPI DLL on Windows using Visual Studio, build the ` .sln ` file
119119in the ` windows/ ` directory.
120120
121- To build HIDAPI using MinGW or Cygwin using Autotools, use a general Autotools
121+ To build HIDAPI using MinGW or Cygwin using Autotools, use general Autotools
122122 [ instruction] ( BUILD.autotools.md ) .
123123
124124Any windows builds (MSVC or MinGW/Cygwin) are also supported by [ CMake] ( BUILD.cmake.md ) .
0 commit comments