mirror of
https://gitlab.gnome.org/GNOME/libsecret.git
synced 2024-12-22 12:48:51 +00:00
Update README
Use markdown formatting (which displays more nicely in GitLab now that we migrated) and give a bit of context to users.
This commit is contained in:
parent
d92265370c
commit
529758c153
@ -171,6 +171,7 @@ CLEANFILES = \
|
|||||||
valgrind-suppressions
|
valgrind-suppressions
|
||||||
|
|
||||||
EXTRA_DIST = \
|
EXTRA_DIST = \
|
||||||
|
README.md \
|
||||||
COPYING.TESTS \
|
COPYING.TESTS \
|
||||||
meson_options.txt \
|
meson_options.txt \
|
||||||
meson.build \
|
meson.build \
|
||||||
|
48
README.md
Normal file
48
README.md
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
libsecret
|
||||||
|
=========
|
||||||
|
|
||||||
|
A [GObject]-based library for accessing the Secret Service API of the
|
||||||
|
[freedesktop.org project], a cross-desktop effort to access passwords, tokens
|
||||||
|
and other types of secrets. libsecret provides a convenient wrapper for these
|
||||||
|
methods so consumers do not have to call the low-level DBus methods.
|
||||||
|
|
||||||
|
The actual Secret Service API spec can be found at
|
||||||
|
https://specifications.freedesktop.org/secret-service/.
|
||||||
|
|
||||||
|
Building
|
||||||
|
--------
|
||||||
|
|
||||||
|
To build and install libsecret, you can use the following commands:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ meson _build
|
||||||
|
$ ninja -C _build
|
||||||
|
$ ninja -C _build install
|
||||||
|
```
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
-------------
|
||||||
|
|
||||||
|
You can browse the code, issues and more at libsecret's [GitLab repository].
|
||||||
|
|
||||||
|
If you find a bug in libsecret, please file an issue on the [issue tracker].
|
||||||
|
Please try to add reproducible steps and the relevant version of libsecret.
|
||||||
|
|
||||||
|
If you want to contribute functionality or bug fixes, please open a Merge
|
||||||
|
Request (MR). For more info on how to do this, see GitLab's [help pages on
|
||||||
|
MR's].
|
||||||
|
|
||||||
|
If libsecret is not translated in your language or you believe that the
|
||||||
|
current translation has errors, you can join one of the various translation
|
||||||
|
teams in GNOME. Translators do not commit directly to Git, but are advised to
|
||||||
|
use our separate translation infrastructure instead. More info can be found at
|
||||||
|
the [translation project wiki page].
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
[GObject]: https://developer.gnome.org/gobject/stable/
|
||||||
|
[freedesktop.org project]: https://www.freedesktop.org/
|
||||||
|
[GitLab repository]: https://gitlab.gnome.org/GNOME/libsecret
|
||||||
|
[help pages on MR's]: https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html
|
||||||
|
[issue tracker]: https://gitlab.gnome.org/GNOME/libsecret/issues
|
||||||
|
[translation project wiki page]: https://wiki.gnome.org/TranslationProject/
|
Loading…
Reference in New Issue
Block a user