summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSiegfried-Angel Gevatter Pujals <siegfried@gevatter.com>2012-11-07 23:16:44 +0100
committerSiegfried-Angel Gevatter Pujals <siegfried@gevatter.com>2012-11-07 23:16:44 +0100
commit0c157c1577925181934b2a2a453f280a9e92c6cd (patch)
tree4929408bd42a7325a5fd41c2fdaecf595861c527 /README
parent7c4ec336a8cc4e5650058e0dc63132fa01a26f1b (diff)
Documentation and autotools fixes
- Added a custom index page for the C documentation - Removed duplicate Vala documentation - Added missing documentation, titles, fixed links, etc. - Fixed autotools to updated the docs whenever needed - Fixed autotools to update the ontology files whenever needed - Updated AUTHORS, added content to README
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 31 insertions, 0 deletions
diff --git a/README b/README
index e69de29b..d5b48bcf 100644
--- a/README
+++ b/README
@@ -0,0 +1,31 @@
+========================== 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.
+
+See AUTHORS for a list of contributors.
+
+For a list of changes between releases, see NEWS; a detailed
+changelog is available in the Git repository at:
+ http://cgit.freedesktop.org/zeitgeist/zeitgeist/
+
+You can also find some additional development and testing tools
+in the Git repository.
+
+---------------------------------------------------------------
+
+CONTRIBUTING
+------------
+
+Feel free to contact us on dev@zeitgeist-project.com or 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.