summaryrefslogtreecommitdiffstats
path: root/README
blob: 93ce42bf527de419ddda72c406e8fcdc42a33286 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
cgserver
========

cgserver is a HTTP server that provides an API to manage cgroups.

Note: This package requires nixos-14.11 (nixos-unstable).


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.nix -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>