1
1
Welcome to synaptiks!
2
2
=====================
4
**synaptiks** is a touchpad configuration and management tool for KDE_,
5
available under the terms of the `simplified BSD licence`_ (see
4
|synaptiks| is a touchpad configuration and management tool for KDE_, available
5
under the terms of the `simplified BSD licence`_ (see :doc:`licence`).
11
**synaptiks** provides a System Settings module to configure both basic and
12
more advanced settings of the touchpad:
10
|synaptiks| provides a |systemsettings| module to configure both basic and more
11
advanced settings of the touchpad:
14
13
.. image:: handbook/scrolling.png
36
35
or off, it can also do this automatically while you are typing, or if you plug
37
36
in an external mouse.
39
The current release is **synaptiks** |release|. Please read the :doc:`list of
40
important changes <changes>` and the :doc:`installation instructions <install>`.
38
The current release is |synaptiks| |release|. Please read the :doc:`list of
39
important changes <changes>` and the :doc:`installation instructions
46
46
Though most of the previously described features should be fairly easy to use,
47
**synaptiks** of course has a extensive Handbook_. You should at last cast a
47
|synaptiks| of course has a extensive Handbook_. You should at last cast a
48
48
short look at the Usage_ chapter to make sure, that you know everything that
49
**synaptiks** can do for you.
49
|synaptiks| can do for you.
51
51
For interested developers :doc:`API documentation <api/index>` is provided.
52
Read this, if you are want to develop **synaptiks** (see :ref:`contribution`
53
for more information on how to contribute to **synaptiks**), or if you are just
52
Read this, if you are want to develop |synaptiks| (see :ref:`contribution` for
53
more information on how to contribute to |synaptiks|), or if you are just
54
54
interested in the internals.
60
If you like or dislike synaptiks or if you have any problems with synaptiks,
61
feel free to send an email with compliments or blame or with some questions.
57
Issues, questions and feedback
58
==============================
60
There is a mailing list at synaptiks@librelist.com (hosted by `librelist.com`_)
61
for user question and development discussions around |synaptiks|. All
62
discussions are published in the `list archives`_. To subscribe to this list,
63
just send an mail to synaptiks@librelist.com and reply to the configuration
64
mail. The original mail is *ditched* and doesn't appear on the list.
66
To unsubscribe, send a mail to synaptiks-unsubscribe@librelist.com and again
67
reply to the configuration mail.
63
69
If you have found a bug in synaptiks, if miss a certain feature or if have any
64
70
proposals concerning synaptiks, please report them to the `issue tracker`_. To
78
84
git clone --recursive git://github.com/lunaryorn/synaptiks
80
Just clone this repository to fix some issue in **synaptiks** or add some new
86
Just clone this repository to fix some issue in |synaptiks| or add some new
81
87
features. Feel free to send pull requests with your work, or provide patches
82
88
by email or in the issue tracker.
84
If you want to translate **synaptiks** into other languages, please read the
90
If you want to translate |synaptiks| into other languages, please read the
85
91
:doc:`translation_guide`. It explains, how translations are handled in
86
**synaptiks** and how you can create new translations or update existing ones.
92
|synaptiks| and how you can create new translations or update existing ones.
89
95
.. _handbook: handbook/index.html
94
100
.. _issue tracker: https://github.com/lunaryorn/synaptiks/issues
95
101
.. _GitHub: https://github.com/lunaryorn/synaptiks
96
102
.. _git: http://git-scm.com/
103
.. _librelist.com: http://librelist.com/
104
.. _list archives: http://librelist.com/browser/synaptiks/
added
removed
doc/index.rst
