diff options
| author | Niels De Graef <nielsdegraef@gmail.com> | 2020-09-28 07:59:12 +0200 |
|---|---|---|
| committer | Niels De Graef <nielsdegraef@gmail.com> | 2020-09-28 07:59:12 +0200 |
| commit | cc249521fc8e0b1f62e0e145a975582afcb8b3fa (patch) | |
| tree | 860d2675104cef309ec266f532ff43f233914a3f | |
| parent | 22ee8731e0d8dd3930e8382c6546ffa7dd25409c (diff) | |
| download | gcr-wip/nielsdg/remove-autotools.tar.gz | |
Convert README to markdownwip/nielsdg/remove-autotools
| -rw-r--r-- | README | 33 | ||||
| -rw-r--r-- | README.md | 60 |
2 files changed, 60 insertions, 33 deletions
@@ -1,33 +0,0 @@ -GCR is a library for displaying certificates, and crypto UI, accessing -key stores. It also provides the viewer for crypto files on the GNOME -desktop. - -GCK is a library for accessing PKCS#11 modules like smart cards, in a -(G)object oriented way. - - -DEBUG TRACING -============== - -The Gcr and Gck libraries contain statements which help debug flow -and logic. In many cases these help you track down problems. - -Use the environment variable G_MESSAGES_DEBUG='all' or G_MESSAGES_DEBUG='xxx' -to display either all messages or a specific categories of debug messages. You -can separate categories in this list with spaces, commas or semicolons. Gcr -library uses category 'Gcr', while Gck library uses category 'Gck'. - -Example to display all debug messages: - - $ G_MESSAGES_DEBUG=all gcr-viewer /path/to/certificate.crt - (gcr-viewer:9418): Gcr-DEBUG: gcr_pkcs11_initialize_async: starting initialize of registered modules - ... - -Example to display debug messages for a specific category: - - $ G_MESSAGES_DEBUG="Gcr" gcr-viewer /path/to/certificate.crt - (gcr-viewer:9503): Gcr-DEBUG: gcr_pkcs11_initialize_async: starting initialize of registered modules - ... - -For the Gck debug messages simply replace 'Gcr' with 'Gck' in the above -examples. diff --git a/README.md b/README.md new file mode 100644 index 0000000..842b217 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +GCR +=== +GCR is a library for displaying certificates and crypto UI, accessing +key stores. It also provides the viewer for crypto files on the GNOME +desktop. + +GCK is a library for accessing PKCS#11 modules like smart cards, in a +(G)object oriented way. + +Building +-------- + +You can build GCR using [Meson] with the following build commands (replace +`$BUILDDIR` with your chosed build directory). + +``` +$ meson $BUILDDIR +$ meson compile -C $BUILDDIR +$ meson install -C $BUILDDIR +``` + +Contributing +------------ +The code and issue tracker of GCR can be found at the GNOME GitLab instance at +https://gitlab.gnome.org/GNOME/gcr. + +If you would like to get involved with GNOME projects, please also visit our +[Newcomers page] on the Wiki. + +Debug tracing +------------- +The Gcr and Gck libraries contain statements which help debug flow +and logic. In many cases these help you track down problems. + +Use the environment variable `G_MESSAGES_DEBUG='all'` or +`G_MESSAGES_DEBUG='xxx'` to display either all messages or a specific categories +of debug messages. You can separate categories in this list with spaces, commas +or semicolons. Gcr library uses category 'Gcr', while Gck library uses category +'Gck'. + +``` +# Example to display all debug messages: +$ G_MESSAGES_DEBUG=all gcr-viewer /path/to/certificate.crt + +# Example to display debug messages for a specific category: +$ G_MESSAGES_DEBUG="Gcr" gcr-viewer /path/to/certificate.crt +``` + +For the Gck debug messages simply replace 'Gcr' with 'Gck' in the above +examples. + +More information +---------------- +To discuss issues with developers and other users, you can post to the +[GNOME Discourse instance](https://discourse.gnome.org). + + + +[Meson]: https://mesonbuild.com +[Newcomers page]: https://wiki.gnome.org/TranslationProject/JoiningTranslation |