Commit graph

18 commits

Author SHA1 Message Date
Sebastian Wick
9cc806c512 readme: List the relevant specifications and where to get them
Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
2024-07-02 18:11:55 +02:00
Simon Ser
147d6611a6 readme: update test suite instructions
Since eed3e1e0f8 ("test: remove edid-decode as a test
dependency"), edid-decode is no longer required to run the test
suite. It's only required to re-generate the test data.

Expand a bit on how to setup edid-decode to re-generate the test
data.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-03-02 19:43:44 +01:00
Simon Ser
5a4a28e226 readme: add IRC channel
The #wayland channel seems like the most popular choice.

Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/emersion/libdisplay-info/-/issues/34
2023-02-15 11:20:36 +00:00
Simon Ser
0154eaa29c readme: document versioning and stability expectations
References: https://gitlab.freedesktop.org/emersion/libdisplay-info/-/issues/13
Signed-off-by: Simon Ser <contact@emersion.fr>
2023-01-17 11:48:41 +01:00
Simon Ser
6cdebd2046 readme: move URL to references list
Makes the plain-text more readable.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-01-17 11:41:33 +01:00
Simon Ser
94f4cd406c readme: fix executable path in fuzzing instructions
di-edid-decode was split into multiple files, so the binary
location has changed.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-01-13 14:22:31 +01:00
Simon Ser
e19ee5d1bc build: add gen-test-data run target
This makes it easier to re-generate the test diffs. The build system
will properly set DI_EDID_DECODE/DI_EDID_PRINT (and will rebuild
these tools if they are out-of-date).

Signed-off-by: Simon Ser <contact@emersion.fr>
2022-11-17 22:10:08 +01:00
Pekka Paalanen
ac857e8985 info: use PNP ID database for manufacturer names
The three character PNP ID is a key to manufacturer name database. It
may be desirable to report the manufacturer's real name than just PNP ID
which can be misleading, e.g. MSI refers to Microstep and not MSI GmbH.

This builds the PNP ID database into libdisplay-info to avoid having to
find and parse files at runtime.

tool/gen-search-table.py started as a copy of Wayland 1.21.0's
src/embed.py and took influence from
10945c4ed8/conv.py
However, our script parses the text file shipped in hwdata package in
Debian (and presumably other distributions) rather than the original
CSV.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2022-11-11 13:09:18 +02:00
Pekka Paalanen
cda99a0913 readme: add Using section
I believe this is what we intended, and it is what I want.

It could lead to duplicating low-level API in high-level API at first,
but once we start seeing DisplayID in the wild, the high-level functions
need to start looking into both EDID and DisplayID APIs to deliver the
desired information.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2022-10-14 13:26:40 +03:00
Pekka Paalanen
6d7ce6dbd8 readme: mention edid-decode version
I was scratching my head for a good while, why does the test suite fail
straight out of upstream on one EDID file. Turns out I was using a
different version of edid-decode than CI, which caused the recorded diff
patch to fail to apply. I was missing

41507c0b5f "ci: update edid-decode"

Make an explicit note about this dependency.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2022-10-14 13:26:37 +03:00
Simon Ser
41d3278807 readme: link to latest code coverage report
Signed-off-by: Simon Ser <contact@emersion.fr>
2022-10-07 07:20:18 +02:00
Simon Ser
2ec42b3bd2 readme: add link to website
The website hosts the documentation.

Signed-off-by: Simon Ser <contact@emersion.fr>
2022-10-05 10:47:44 +00:00
Andrea Pappacoda
2d889cead4
build: stop using meson's implicit setup command
It will be deprecated in the next release, 0.64.0. See
https://github.com/mesonbuild/meson/pull/10701

Signed-off-by: Andrea Pappacoda <andrea@pappacoda.it>
2022-08-23 23:14:31 +02:00
Simon Ser
0b6970ed70 readme: document fuzzing setup
These are just the standard AFL instructions, adapted to Meson.

Signed-off-by: Simon Ser <contact@emersion.fr>
2022-06-10 14:08:57 +00:00
Simon Ser
ac8ecd781a readme: add building section
Basic instructions to build the library.

Signed-off-by: Simon Ser <contact@emersion.fr>
2022-06-10 14:08:57 +00:00
Simon Ser
a8e78208a5 Add edid-decode testing infrastructure
Add two small shell utilities to generate and compare diffs between
edid-decode and di-edid-decode. Store the diffs in-tree and add tests
to ensure they don't regress. Run the tests in CI with a pinned
installation of edid-decode.

One EDID blob is added to the test collection: dell-2408wfp-dp. It's
extracted [1] from the edid-decode repository.

[1]: https://git.linuxtv.org/edid-decode.git/tree/data/dell-2408wfp-dp

Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/emersion/libdisplay-info/-/issues/5
2022-05-12 11:35:58 +02:00
Simon Ser
38a8028c69 readme: add goals
Explain our goals for the library.

Signed-off-by: Simon Ser <contact@emersion.fr>
2022-04-04 19:21:02 +00:00
Simon Ser
f4b94b9261 Initial commit
Signed-off-by: Simon Ser <contact@emersion.fr>
2022-03-24 01:49:00 +01:00