dbd9ba3b42067509aa269d775d146a1948f708a0 — Louis Solofrizzo 13 days ago 12a65a5 master
Readme: Add basic but incomplete README

Signed-off-by: Louis Solofrizzo <lsolofrizzo@online.net>
1 files changed, 72 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +72 -0
@@ 0,0 1,72 @@
+ # cisco
+ 
+ ![XKCD - The Cloud](https://imgs.xkcd.com/comics/the_cloud.png)
+ 
+ _Home cloud_ - [LouiFox instance](https://api.louifox.house)
+ 
+ ## Table of Contents
+ 
+ * [About the Project](#about-the-project)
+ * [Getting Started](#getting-started)
+   * [Prerequisites](#prerequisites)
+   * [Installation](#installation)
+   * [Compilation](#compilation)
+ * [Usage](#usage)
+   * [LXD Cluster](#lxd-cluster)
+   * [api](#worker)
+   * [csc](#csc)
+ * [Contributing](#contributing)
+ * [Bug Report](#bug-report)
+ 
+ ## About the Project
+ 
+ `cisco` is an effort to add a more cloud-oriented API over a LXD Cluster. The
+ main features are what you'll expect in any major cloud provider: Tokens,
+ Quotas, Regions, Different instance types, etc. It is mainly made for homelabs,
+ please don't use this in production anywhere.
+ 
+ ## Getting started
+ 
+ ### Prerequisites
+ 
+ - You'll need to have an LXD cluster, with working network configuration
+ - IPv6 on your cluster
+ - Some servers!
+ 
+ ### Installation
+ ### Compilation
+ 
+ In order to compile the stack, you will need:
+ 
+ - `golang>=1.11`
+ - `cmake`
+ 
+ Clone the repository:
+ 
+     git clone https://git.mobley.ne02ptzero.me/~louis/cisco
+ 
+ `cd` and create the build directory:
+ 
+     cd cisco && mkdir -p build && cd build && cmake ..
+ 
+ Compile everything:
+ 
+     make
+ 
+ ## Usage
+ ### LXD Cluster
+ ### api
+ ### csc
+ 
+ ## Contributing
+ 
+ If you want to contribute, please send your patches to
+ [~louis/cisco@lists.mobley.ne02ptzero.me](mailto:~louis/cisco@lists.mobley.ne02ptzero.me)
+ You can look at [git-send-email.io](https://git-send-email.io/) if you need to
+ setup your mail client.
+ 
+ ## Bug Report
+ Please report your bugs at
+ [todo/~louis/cisco](https://todo.mobley.ne02ptzero.me/~louis/cisco) You can also
+ send an email to
+ [~louis/cisco@todo.mobley.ne02ptzero.me](mailto:~louis/cisco@todo.mobley.ne02ptzero.me)