From 8b517ce5d0dd646ce9574975985bfc5ca581ab18 Mon Sep 17 00:00:00 2001 From: Stamatis Katsaounis Date: Thu, 2 Jan 2020 14:27:47 +0200 Subject: [PATCH] Add README Signed-off-by: Stamatis Katsaounis --- README.md | 17 +++++++++++++++++ src/HACKING.md | 3 --- 2 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0996c14 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Watcher Source Charm + +This repository is for the reactive, layered, +[Watcher](https://wiki.openstack.org/wiki/Watcher) _source_ charm. + +Please see the src/README.md for details on the built Watcher charm +and how to use it. + +## Building the charm + +To build the charm run the following command in the root of the repository: + +```bash +$ tox -e build +``` + +The resultant built charm will be in the builds directory. diff --git a/src/HACKING.md b/src/HACKING.md index a3b8a24..19ad35e 100644 --- a/src/HACKING.md +++ b/src/HACKING.md @@ -4,6 +4,3 @@ This charm is developed by Stamatis Katsaounis and OpenStack Charms project. You can find its source code here: . - - -