summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAlexander Sulfrian <alexander.sulfrian@fu-berlin.de>2017-03-09 19:21:43 +0100
committerAlexander Sulfrian <alexander.sulfrian@fu-berlin.de>2017-03-09 19:25:07 +0100
commit92f6751afb474144b33e9d43a8c662ce50f199d5 (patch)
tree266ca3b72896048121bf08c93005ebd78944567a /README.rst
parent26944da6adc79a14783fee84112a0ae31cbf6d62 (diff)
downloadbcfg2-92f6751afb474144b33e9d43a8c662ce50f199d5.tar.gz
bcfg2-92f6751afb474144b33e9d43a8c662ce50f199d5.tar.bz2
bcfg2-92f6751afb474144b33e9d43a8c662ce50f199d5.zip
README: Rename README to enable github formatting
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 000000000..9c99d31c1
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,50 @@
+Bcfg2 - A Configuration Management System
+-----------------------------------------
+
+Bcfg2 (bee-config two) helps system administrators produce a
+consistent, reproducible, and verifiable description of their
+environment, and offers visualization and reporting tools to aid
+in day-to-day administrative tasks. It is the fifth generation of
+configuration management tools developed in the Mathematics and
+Computer Science Division of Argonne National Laboratory.
+
+* Homepage: http://bcfg2.org
+
+Bcfg2 is fairly portable. It has been successfully run on:
+
+* AIX, FreeBSD, OpenBSD Mac OS X, OpenSolaris, Solaris
+* Many GNU/Linux distributions, including Arch Linux, Blag, CentOS,
+ Debian, Fedora, Gentoo, gNewSense, Mandriva, openSUSE, Red Hat/RHEL,
+ SuSE/SLES, Trisquel, and Ubuntu.
+
+Installation
+------------
+
+For details about the installation of Bcfg2 please refer to the
+following pages in the Bcfg2 online documentation:
+
+* Prerequisites: http://docs.bcfg2.org/installation/prerequisites.html
+* Download: http://bcfg2.org/download/
+* Installation: http://docs.bcfg2.org/installation/index.html
+
+Need help
+---------
+
+A lot of documentation is available in the Bcfg2 manual and the Bcfg2 wiki.
+
+* Documentation: http://docs.bcfg2.org/
+* Wiki: http://bcfg2.org/wiki/
+* FAQ: http://bcfg2.org/wiki/FAQ
+* IRC: #bcfg2 on chat.freenode.net
+* Mailing list: https://lists.mcs.anl.gov/mailman/listinfo/bcfg-dev
+
+Want to help
+-------------
+
+* Bug tracker: http://bcfg2.org/report
+* Development: http://docs.bcfg2.org/development/
+* Wiki: http://bcfg2.org/wiki/Contribute
+
+
+Bcfg2 is licensed under a Simplified (2-clause) BSD license. For more
+details check LICENSE.