xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-23 14:35:38 +00:00
Code Issues Releases Wiki Activity

Update the README to reflect the new documentation URL

Browse Source
This commit is contained in:
Victor Hu
2015-08-20 16:09:31 -04:00
parent 124c159d87
commit 6fd866e1a8
2 changed files with 19 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README
View File

@ -2,7 +2,7 @@ xCAT - eXtreme Cloud Administration Toolkit
xCAT is a toolkit for the deployment and administration of clusters.
xCAT documentation is available at: http://xcat.sourceforge.net/
xCAT documentation is available at: http://xcat-docs.readthedocs.org/en/latest/
xCAT is made available as open source software under the EPL license:
http://www.opensource.org/licenses/eclipse-1.0.php

18
docs/README.md Normal file
View File

@ -0,0 +1,18 @@
# Welcome to the xCAT documentation
We are working on improving the documentation. The latest docs are here: http://xcat-docs.readthedocs.org/en/latest/
The documentation project is written in restructured text (.rst) using Sphinx.
To build the docs locally:
* Clone the project
* Using pip, install sphinx (See: http://pip.readthedocs.org/)
~~~~
pip install sphinx
~~~~
* Build the Docs
~~~~
cd xcat-docs/docs
make html
~~~~
* View the docs by opening index.html from a web browser under xcat-docs/docs/build/html/index.html