Skip to content

Commit

Permalink
Replace README with markdown version
Browse files Browse the repository at this point in the history
  • Loading branch information
andig committed Feb 25, 2015
1 parent 7a6b8ce commit f4ce2ae
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 27 deletions.
27 changes: 0 additions & 27 deletions README

This file was deleted.

64 changes: 64 additions & 0 deletions README.md
@@ -0,0 +1,64 @@
# volkszaehler.org

volkszaehler.org is a free smart meter implementation with focus on data privacy.

[![Build Status](https://travis-ci.org/volkszaehler/volkszaehler.org.png?branch=master)](https://travis-ci.org/volkszaehler/volkszaehler.org.png?branch=master)


## Demo

http://demo.volkszaehler.org

![Screenshot](misc/docs/screenshot.png?raw=true)


## Quickstart

From the shell:

wget --no-check-certificate https://raw.github.com/volkszaehler/volkszaehler.org/master/misc/tools/install.sh
sudo bash install.sh

Or follow the detailed installation instructions at http://wiki.volkszaehler.org/software/middleware/installation


## Documentation

* Website: http://volkszaehler.org
* Wiki: http://wiki.volkszaehler.org


## Support

* Users mailing list: volkszaehler@lists.volkszaehler.org
* Developers mailing list: volkszaehler-dev@lists.volkszaehler.org


## Repository structure

volkszaehler.org/
|_ etc/ configuration files
|_ htdocs/ public web files
| |_ middleware.php middleware
| \_ frontend web ui
|
|_ lib/ middleware libraries
\_ misc/
|_ controller/
| |_ vzlogger/ command line tool to log meters/sensors
| \_ mbus/ a controller for mbus/messbus
|
|_ docs/ documentation
|_ frontend/ alternative frontends
|_ graphics/ several graphics for docs, etc.
|_ sql/ database schema dumps
| \_ demo/ demo data
|
|_ tools/ scripts for imports, installation etc.
\_ tests/ simple tests for middleware classes


## Copyright

Copyright © 2015 volkszaehler.org
Licensed under the GNU Public License (http://opensource.org/licenses/gpl-license.php).

0 comments on commit f4ce2ae

Please sign in to comment.