xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-21 19:22:05 +00:00
Code Issues Releases Wiki Activity

Replace the README.rst with a Markdown file, add badges for documentation status

Browse Source
This commit is contained in:
Victor Hu 2019-04-11 15:30:25 -04:00
parent eeac8b72f0
commit a3cf49f4c5
2 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# xCAT
xCAT is a toolkit for deployment and administration of clusters of all sizes.
# Documentation
xCAT Documentation is hosted on Read The Docs: https://xcat-docs.readthedocs.io
## Status
| xCAT Version | Build Status |
|---|---|
| Latest (master branch) | [![Documentation Status](https://readthedocs.org/projects/xcat-docs/badge/?version=latest)](https://xcat-docs.readthedocs.io/en/latest/) |
| Stable (latest release) | [![Documentation Status](https://readthedocs.org/projects/xcat-docs/badge/?version=stable)](https://xcat-docs.readthedocs.io/en/stable/) |
Looking for [older versions](https://readthedocs.org/projects/xcat-docs/versions/)?
# Open Source License
xCAT is made available under the EPL license: https://opensource.org/licenses/eclipse-1.0.php
# Developers
Want to help? Check out the [developers guide](http://xcat-docs.readthedocs.io/en/latest/developers)!

26
README.rst
View File

@ -1,26 +0,0 @@
xCAT
----
xCAT is a toolkit for the deployment and administration of clusters.
Documentation
-------------
`The stable documentation of xCAT <https://xcat-docs.readthedocs.io/en/stable/>`_
`The latest documentation of xCAT <http://xcat-docs.readthedocs.io/en/latest/index.html>`_
`The documentation of xCAT each release <http://readthedocs.org/projects/xcat-docs/versions/>`_
Open Source License
-------------------
xCAT is made available as open source software under the EPL license:
http://www.opensource.org/licenses/eclipse-1.0.php
Developers
----------
Developers and prospective contributors are encouraged to read the `Developers Guide <http://xcat-docs.readthedocs.io/en/latest/developers/>`_
In particular the `GitHub <http://xcat-docs.readthedocs.io/en/latest/developers/github/>`_ related subsection.