Pretty up the README

Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
This commit is contained in:
Angus Salkeld 2012-03-19 22:51:55 +11:00
parent d3ca2e3d37
commit 248a693581
2 changed files with 41 additions and 24 deletions

24
README
View File

@ -1,24 +0,0 @@
This is the beginings of a AWS Cloudformation API written
in the style of an openstack project.
Why heat? It makes the clouds raise and keeps them there.
Install:
./setup.py build
./setup.py install
Set up config:
cp ./etc/heat-api ./etc/heat-api.conf
try:
heat-api
and in another shell
heat create my_stack --template-file=./templates/getting_started.template --parameters "param1=foo;param2=bar"
References:
http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html
http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/create-stack.html

41
README.rst Normal file
View File

@ -0,0 +1,41 @@
====
HEAT
====
This is the beginings of a AWS Cloudformation API written
in the style of an openstack project.
Why heat? It makes the clouds raise and keeps them there.
Quick Start
-----------
If you'd like to run trunk, you can clone the git repo:
git clone git@github.com:heat-api/heat.git
Install Heat by running::
python setup.py build
sudo python setup.py install
try:
shell1:
heat-api
shell2:
sudo heat-engine
shell3:
heat create my_stack --template-url=https://github.com/heat-api/heat/blob/master/templates/WordPress_Single_Instance.template
References:
http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html
http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/create-stack.html