summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README64
1 files changed, 64 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..f4de3fb
--- /dev/null
+++ b/README
@@ -0,0 +1,64 @@
+cgserver
+========
+
+cgserver is a HTTP server that provides an API to manage cgroups.
+
+
+Files in this Repository
+========================
+
+cgserver.nix
+------------
+This files was generated from cgserver.cabal by:
+
+ $ cabal2nix . > cgserver.nix
+
+Both, default.nix, and env.nix use this file (see below).
+
+
+default.nix
+-----------
+A nix package that builds the cgserver executable.
+
+It can be used by:
+
+ $ nix-env -f . -i
+
+
+env.nix
+-------
+A development environment. Within the environment GHCi and cabal-install
+can be used develop cgserver.
+
+The environment can be installed by:
+
+ $ nix-env -f env -i
+
+Load the environment:
+
+ $ load-env-cgserver-1
+
+Start cgserver with GHCi:
+
+ $ ghci -Wall -isrc
+ > :l Main
+ > main
+
+
+cgserver.cabal, LICENSE, src/
+-----------------------------
+The obvious scaffold.
+
+Most of the documentation is Haddock and can be generated by:
+
+ $ cabal haddock --executable
+
+
+Contact Information
+===================
+Contributions and bug reports are welcome!
+
+Please feel free to contact me by email or on the #krebs IRC channel on
+irc.freenode.net.
+
+-- Tomislav Viljetić <tomislav@viljetic.de>