From c7911372370bed183d9fe2d41324a09d879654d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Sommer?= Date: Fri, 8 Dec 2023 15:32:47 +0100 Subject: [PATCH 1/3] Remove duplicate README, Github can handle README.md --- README | 56 -------------------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index af1c1ae..0000000 --- a/README +++ /dev/null @@ -1,56 +0,0 @@ -# i2cdev -I2C library and tools (lsi2c) for linux - -I2C DEV TOOLS FOR LINUX -=================== - -This package contains an I2C dev library. - - -CONTENTS --------- - -The various tools included in this package are grouped by category, each -category has its own sub-directory: - -* include - C/C++ header files for I2C and SMBus access over i2c-dev. Installed by - default. - -* lib - The I2C library. Installed by - default. - -* lsi2c - The i2c bus scanning utility - -LICENSE -------- - - LGPL - -INSTALLATION ------------- - -./autogen.sh -./configure then simply run "make" to build the library and -tools, and "make install" to install them. You also can use "make uninstall" -to remove all the files you installed. By default, files are installed in -/usr/local but you can change the location by editing the Makefile file and -setting prefix to wherever you want. You may change the C compiler and the -compilation flags as well, and also decide whether to build the static -library or not. - -Optionally, you can run "make strip" prior to "make install" if you want -smaller binaries. However, be aware that this will prevent any further -attempt to debug the library and tools. - - -DOCUMENTATION -------------- -See files in doc folder - -QUESTIONS AND BUG REPORTS -------------------------- - - From fdd3973e1da9aa994cc4d4239546470d10d717ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Sommer?= Date: Fri, 8 Dec 2023 15:51:37 +0100 Subject: [PATCH 2/3] README: Improve License section It is helpful the state, that this project uses two different licenses. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index af1c1ae..02a19d1 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,15 @@ category has its own sub-directory: LICENSE ------- - LGPL +Be aware that some files are released under GPL-2.0-or-later, everything else is +under LGPL-2.1-or-later. + +Files with GPL-2.0-or-later: + +* include/libi2cdev.h +* libi2cdev/smbus.c +* lsi2c/lsi2c.c + INSTALLATION ------------ From 34c3fcf779fc4e10952548742362a16db70fe7ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Sommer?= Date: Fri, 8 Dec 2023 15:52:35 +0100 Subject: [PATCH 3/3] README: Improve formatting --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 02a19d1..c5493e6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # i2cdev + I2C library and tools (lsi2c) for linux I2C DEV TOOLS FOR LINUX -=================== +======================= This package contains an I2C dev library. @@ -13,16 +14,12 @@ CONTENTS The various tools included in this package are grouped by category, each category has its own sub-directory: -* include - C/C++ header files for I2C and SMBus access over i2c-dev. Installed by - default. +* *include:* C/C++ header files for I2C and SMBus access over i2c-dev. Installed + by default. + +* *lib:* The I2C library. Installed by default. -* lib - The I2C library. Installed by - default. - -* lsi2c - The i2c bus scanning utility +* *lsi2c:* The i2c bus scanning utility LICENSE ------- @@ -40,25 +37,27 @@ Files with GPL-2.0-or-later: INSTALLATION ------------ -./autogen.sh -./configure then simply run "make" to build the library and -tools, and "make install" to install them. You also can use "make uninstall" +At first, run `./autogen.sh && ./configure`, and then simply run `make` to build +the library and tools, and `make install` to install them. You also can use +`make uninstall` to remove all the files you installed. By default, files are installed in /usr/local but you can change the location by editing the Makefile file and setting prefix to wherever you want. You may change the C compiler and the compilation flags as well, and also decide whether to build the static library or not. -Optionally, you can run "make strip" prior to "make install" if you want +Optionally, you can run `make strip` prior to `make install` if you want smaller binaries. However, be aware that this will prevent any further attempt to debug the library and tools. DOCUMENTATION ------------- -See files in doc folder + +See files in *doc* folder + QUESTIONS AND BUG REPORTS ------------------------- - +See