From 2b70208feabeb4cb524dff58c450af63544790bc Mon Sep 17 00:00:00 2001 From: CanDursun <48656980+CanDursun@users.noreply.github.com> Date: Fri, 4 Nov 2022 15:01:41 +0300 Subject: [PATCH] Fix typos in README (#479) --- BUILD.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/BUILD.md b/BUILD.md index 2497470..d7a3546 100644 --- a/BUILD.md +++ b/BUILD.md @@ -14,7 +14,7 @@ ## Intro -For various reasons you may need to build HIDAPI on your own. +For various reasons, you may need to build HIDAPI on your own. It can be done in several different ways: - using [CMake](BUILD.cmake.md); @@ -22,13 +22,13 @@ It can be done in several different ways: - using [manual makefiles](#building-the-manual-way-on-unix-platforms); - using `Meson` (requires CMake); -**Autotools** build system is historically first mature build system for -HIDAPI. Most common usage of it is in its separate README: [BUILD.autotools.md](BUILD.autotools.md).
+**Autotools** build system is historically the first mature build system for +HIDAPI. The most common usage of it is in its separate README: [BUILD.autotools.md](BUILD.autotools.md).
NOTE: for all intentions and purposes the Autotools build scripts for HIDAPI are _deprecated_ and going to be obsolete in the future. HIDAPI Team recommends using CMake build for HIDAPI. **CMake** build system is de facto an industry standard for many open-source and proprietary projects and solutions. -HIDAPI is one of the projects which uses the power of CMake for its advantage. +HIDAPI is one of the projects which use the power of CMake to its advantage. More documentation is available in its separate README: [BUILD.cmake.md](BUILD.cmake.md). **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 ## Prerequisites: -Regardless of what build system system you choose to use, there are specific dependencies for each platform/backend. +Regardless of what build system you choose to use, there are specific dependencies for each platform/backend. ### Linux: Depending on which backend you're going to build, you'll need to install -additional development packages. For `linux/hidraw` backend you need +additional development packages. For `linux/hidraw` backend, you need a development package for `libudev`. For `libusb` backend, naturally, you need `libusb` development package. @@ -59,7 +59,7 @@ sudo apt install libusb-1.0-0-dev ### FreeBSD: -On FreeBSD you will need to install libiconv. This is done by running +On FreeBSD, you will need to install libiconv. This is done by running the following: ```sh pkg_add -r libiconv @@ -67,11 +67,11 @@ pkg_add -r libiconv ### Mac: -On Mac make sure you have XCode installed and its Command Line Tools. +Make sure you have XCode installed and its Command Line Tools. ### Windows: -On Windows you just need a compiler. You may use Visual Studio or Cygwin/MinGW, +You just need a compiler. You may use Visual Studio or Cygwin/MinGW, depending on which environment is best for your needs. ## Embedding HIDAPI directly into your source tree @@ -95,7 +95,7 @@ depending on your platform and the backend you want to use: - make the platform/backend specific [dependencies](#prerequisites) available during the compilation/linking, when building `hid.c`; NOTE: the above doesn't guarantee that having a copy of `/hid.c` and `hidapi/hidapi.h` is enough to build HIDAPI. -The only guarantee that `/hid.c` includes all nesessary sources to compile it as a single file. +The only guarantee that `/hid.c` includes all necessary sources to compile it as a single file. Check the manual makefiles for a simple example/reference of what are the dependencies of each specific backend. @@ -106,7 +106,7 @@ to build a program which embeds HIDAPI directly inside of it. These should really be used as examples only. If you want to build a system-wide shared library, use one of the build systems mentioned above. -To build HIDAPI using the manual Makefiles, change to the directory +To build HIDAPI using the manual Makefiles, change the directory of your platform and run make. For example, on Linux run: ```sh cd linux/ @@ -118,7 +118,7 @@ make -f Makefile-manual To build the HIDAPI DLL on Windows using Visual Studio, build the `.sln` file in the `windows/` directory. -To build HIDAPI using MinGW or Cygwin using Autotools, use a general Autotools +To build HIDAPI using MinGW or Cygwin using Autotools, use general Autotools [instruction](BUILD.autotools.md). Any windows builds (MSVC or MinGW/Cygwin) are also supported by [CMake](BUILD.cmake.md).