Skip to content

Improvements of README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jo-so-nx wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improvements of README #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c791137
Remove duplicate README, Github can handle README.md
jo-so-nx Dec 8, 2023
fdd3973
README: Improve License section
jo-so-nx Dec 8, 2023
34c3fcf
README: Improve formatting
jo-so-nx Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 0 additions & 56 deletions README
View file
Open in desktop

This file was deleted.

41 changes: 24 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# i2cdev

I2C library and tools (lsi2c) for linux

I2C DEV TOOLS FOR LINUX
===================
=======================

This package contains an I2C dev library.

Expand All @@ -13,44 +14,50 @@ 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
-------

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
------------

./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 <https://github.com/costad2/i2cdev/issues>