path: root/README
diff options
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-17 00:27:43 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-17 00:27:43 +0000
commit103e5770f120d70b1580bfc3cab8219c6608bc21 (patch)
tree55d04f6fbf26db1698fb12264ac3b86c40455187 /README
Initial import
Diffstat (limited to 'README')
1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 000000000..2226fdb92
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+README for Paludis
+Paludis is in the really early prototype not intended for real use stage. If you
+aren't comfortable with C++, ebuild internals and Gentoo in general then you
+shouldn't be touching it.
+Developer documentation is available via 'make doxygen' (you need Doxygen
+installed, and having GraphViz will help too). It will be created under
+'doc/html/'. User documentation is kept in the bottom of a locked filing cabinet
+stuck in a disused lavatory with a sign on the door saying 'Beware of the
+.. vim: set spell spelllang=en tw=80 : ..