summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCorentin Noël <corentin@elementary.io>2018-05-05 19:21:17 +0100
committerCorentin Noël <corentin@elementary.io>2018-05-05 19:23:46 +0100
commite5ee7accb7057631c7e83a1c372e7c5c161c409d (patch)
tree9f9814fcd4ec0c2b4e72676f909629db333c7206 /README.md
parent5a15353b5f5173a337cdd6660a1d885eb35fa84c (diff)
downloadzeitgeist-e5ee7accb7057631c7e83a1c372e7c5c161c409d.tar.gz
Use Markdown for the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..c1dc0676
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Zeitgeist
+
+Zeitgeist is a service which logs the users's activities and events (files opened, websites visites, conversations held with other people, etc.) and makes relevant information available to other applications.
+
+For a list of changes between releases, see NEWS; a detailed changelog is available in the Git repository at: https://gitlab.freedesktop.org/zeitgeist/zeitgeist
+
+You can also find some additional development and testing tools in the Git repository.
+
+The documentation is available in the official website: http://zeitgeist.freedesktop.org
+
+## Contributing
+
+Feel free to contact us via IRC in #zeitgeist on irc.freenode.net.
+
+Coding conventions:
+
+ - Generally following the GNOME / Vala guidelines.
+ - Indentation with 4 spaces.
+ - No indentation for namespaces (except for historic reasons).
+ - In libzeitgeist/, "protected" used for non-public API when "private"/"internal" can't be used.