[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[dak/master] Rename README, reword a bit, markdownify it



---
 README    | 37 -------------------------------------
 README.md | 28 ++++++++++++++++++++++++++++
 2 files changed, 28 insertions(+), 37 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 2f9d5909..00000000
--- a/README
+++ /dev/null
@@ -1,37 +0,0 @@
-***** WARNING ****** ***** WARNING ***** ****** WARNING ******
-
-This is unreleased alpha software; use it ENTIRELY at your own risk.
-
-***** WARNING ****** ***** WARNING ****** ***** WARNING ******
-
-dak is the collection of programs used to maintain the Debian
-project's archives.  It's not yet in a state where it can be easily
-used by others; if you want something to maintain a small archive and
-apt-ftparchive (from the apt-utils package) is insufficient, I strongly
-recommend you investigate mini-dinstall, debarchiver or similar.
-However, if you insist on trying to try using dak, please read the
-documentation in 'doc/README.first'.
-
-There are some manual pages and READMEs in the doc sub-directory.  The
-TODO file is an incomplete list of things needing to be done.
-
-There's a mailing list for discussion, development of and help with
-dak.  See:
-
-  https://lists.debian.org/debian-dak/
-
-for archives and details on how to subscribe.
-
-dak is developed and used on Linux but will probably work under any
-UNIX since it's almost entirely python and shell scripts.
-
-dak is free software; you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free
-Software Foundation; either version 2 of the License, a copy of which
-is provided under the name COPYING, or (at your option) any later
-version.
-
--- 
-James Troup <james@nocrew.org>, Horsforth, Leeds
-Thu, 26 Dec 2002 16:56:02 +0000
-
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..1a99c8ca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# dak - Debian Archive Kit
+
+dak is the collection of programs used to maintain the Debian
+project's archives. It is highly optimized for the Debian project,
+though can be used by others too.
+
+## More reading
+There are some manual pages and READMEs in the [doc](doc) sub-directory.  The
+[TODO](doc/TODO) file is an incomplete list of things needing to be done.
+
+There's a mailing list for discussion, development of and help with
+dak.  See:
+
+  https://lists.debian.org/debian-dak/
+
+for archives and details on how to subscribe.
+
+# Setup
+You can find more info about setting dak up inside the [setup](setup)
+Folder and its [README](setup/README).
+
+# License
+
+dak is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2 of the License, a copy of which
+is provided under the name COPYING, or (at your option) any later
+version.
-- 
2.11.0


Reply to: