Peter Hutterer
7d784a1a91
doc: use USE_MDFILE_AS_MAINPAGE to include the README.md as mainpage
...
Supported as of doxygen 1.8.3 (Dec 2012), see
http://www.stack.nl/~dimitri/doxygen/manual/changelog.html#log_1_8_3
Fixes #145
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2017-04-20 11:28:05 +02:00
Peter Hutterer
f2ad49cf20
Add meson build file
...
For a builddir called 'builddir', the following commands are sufficient now:
meson builddir
ninja -C builddir
sudo ninja -C builddir install
Meson only needs to be run once after checkout or after the removal of the
builddir.
Fixes https://github.com/libratbag/libratbag/issues/142
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2017-04-19 14:40:57 +02:00
Peter Hutterer
85fdea19c2
Link to the github-pages generated documentation
...
To update the documentation, do the following:
# delete current documentation
pushd doc/html
rm -rf $PWD/*
# clone into current directory, checkout gh-pages
git clone git@github.com:libratbag/libratbag .
git checkout -b gh-pages
# delete master branch so we don't accidentally push that one
git branch -d master
# return to main, generate docs
popd
make
# commit updated docs, push
pushd doc/html
git commit -asm "Updated documentation"
git push origin gh-pages
popd
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2016-03-17 15:21:06 +10:00
Peter Hutterer
1b20beaada
README: fix device-notes repository link
...
We renamed it, a bit less awkward this way.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2015-10-15 09:48:51 +10:00
Peter Hutterer
0b74605779
README: link to mailing list, devices-notes repo, etc.
...
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2015-10-15 09:15:45 +10:00
Peter Hutterer
357191b1e0
Improve the README a bit
...
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2015-10-12 10:55:26 +10:00
Benjamin Tissoires
439e287776
fix readme for the doc
...
github is happy with the current README but doxygen is not.
Use the same formatting than the architecture.
Signed-off-by: Benjamin Tissoires <benjamin.tissoires@gmail.com >
2015-10-09 17:23:42 -04:00
Benjamin Tissoires
e606473198
update README
...
update README to reflect the hwdb change.
Signed-off-by: Benjamin Tissoires <benjamin.tissoires@gmail.com >
2015-10-09 17:19:16 -04:00
Peter Hutterer
a5b166c525
README: add basic instructions for adding new devices
...
This is for the best case where it's just about adding a new device ID. In the
case where reverse engineering is required, some more detailed instructions
are necessary but they take more effort to write...
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2015-09-19 06:43:54 +10:00
Peter Hutterer
f71f10277a
README: add the missing extra space for monospace formatting
...
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2015-09-19 06:23:07 +10:00
Peter Hutterer
44d0fd6d93
README.md: add semaphore build status badge
...
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2015-09-19 06:14:53 +10:00
Peter Hutterer
e981f1b2a7
README: add a short explanation on the architecture
...
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2015-09-13 00:40:09 +10:00
Peter Hutterer
3fefe97451
Scaffolding for a libratbag, a mouse configuration library
...
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net >
2015-08-13 11:55:07 +10:00
