1
0
mirror of https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git synced 2026-10-24 00:48:53 +03:00
Commit Graph

16 Commits

Author SHA1 Message Date
Bartosz Golaszewski
dda57bd63f doc: move README contents to sphinx docs
We now have comprehensive documentation available online on readthedocs.
Let's not duplicate docs in README - move all information into the
sphinx files.

While at it: make the remaining README use markdown.

Reviewed-by: Vincent Fazio <vfazio@xes-inc.com>
Link: https://lore.kernel.org/r/20250211-improve-docs-v4-17-dc56702c2ca8@linaro.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
2025-02-17 09:18:27 +01:00
Bartosz Golaszewski
ee0b9c4970 README.md: rename to README
We now host libgpiod at kernel.org, so no need for the .md file.

This also fixes 'make dist' as README.md was not being packaged by
autotools.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-09-12 18:00:33 +02:00
Bartosz Golaszewski
b01d4ebf86 gpiomon: implement monitoring multiple lines at the same time
Switch from the simple API to low-level libgpiod routines and
implement watching multiple lines at the same time.

Update tests and README.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-06-23 16:14:15 +02:00
Bartosz Golaszewski
fdd037c0dd README: improve readability of examples
We're using the same character for comments and the command prompt.
That's not very readable. Use '$' as prompt.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-06-22 21:17:13 +02:00
Bartosz Golaszewski
f0b441006a README: add an example of gpiomon custom output formats
In the examples section: show how to specify a custom, easily parsable
output in gpiomon.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-06-22 21:14:55 +02:00
Bartosz Golaszewski
b762371aaa README: update the building section
Commit 6876721f74 ("build: use a more standard autogen.sh") made
the supplied autogen execute ./configure unless the NOCONFIGURE
environment variable is set. Reflect that in the README file.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-06-22 20:43:41 +02:00
Bartosz Golaszewski
8b872ad894 README: explain what gpiod stands for
In case someone incorrectly thinks it stands for 'GPIO daemon'.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-06-07 18:08:47 +02:00
Bartosz Golaszewski
2f5d950907 tests: rename gpiod-unit to gpiod-test
The testing framework will be reused for all kinds of tests. Also: the
tests we have are not really separated, but use external components so
calling them unit tests is wrong anyway.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-05-14 13:18:39 +02:00
Bartosz Golaszewski
715791a3a3 tests: remove the unit subdirectory
Initially we planned to have different subdirectories for different
kinds of tests (unit, tools etc.) but since it was decided that we'll
reuse the already existing framework for all tests (in order to avoid
having to reimplement the same functionality) we can get rid of the
unit subdirectory.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-05-14 13:09:36 +02:00
Bartosz Golaszewski
35a5fdb252 README: add some info on unit tests
Describe how to build and use the testing framework.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-05-05 17:43:06 +02:00
Bartosz Golaszewski
16a4509bce README: fix the required version of kernel headers
The project actually needs kernel headers >= v4.8 to compile.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-01-19 15:55:15 +01:00
Bartosz Golaszewski
3bb17199ab README: add examples
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-01-18 11:57:35 +01:00
Bartosz Golaszewski
32c5f1e32b README: add the autoconf version needed to compile the project
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-01-18 11:30:25 +01:00
Bartosz Golaszewski
a368f483c9 README: add bullet points to the tool list
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-01-18 11:26:49 +01:00
Bartosz Golaszewski
8c1d99e263 README: the introduction is not a code block
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-01-18 11:10:36 +01:00
Bartosz Golaszewski
5546e3a5d0 README: rename to README.md for nice github cover
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
2017-01-18 11:09:42 +01:00