updated docs
This commit is contained in:
Steffen Vogel
parent
159fbb37ac
commit
240bb671ed
|
|
@ -1 +1,5 @@
|
|||
There is no stable release yet. Have some patience please or contribute.
|
||||
2011-08-08 Steffen Vogel <info@steffenvogel.de>
|
||||
|
||||
* First official release
|
||||
* To many features to mention them here Take a look at:
|
||||
http://bugs.volkszaehler.org/changelog_page.php?version_id=1
|
||||
|
|
|
|||
53
COPYING
53
COPYING
|
|
@ -619,56 +619,3 @@ Program, unless a warranty or assumption of liability accompanies a
|
|||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
|
|
|
|||
4
INSTALL
4
INSTALL
|
|
@ -1 +1,3 @@
|
|||
Refer to the wiki: http://wiki.volkszaehler.org/howto/getstarted
|
||||
There is an small script named install.sh which should do the installation for you.
|
||||
|
||||
For more info refer to the wiki: http://wiki.volkszaehler.org/howto/getstarted
|
||||
|
|
|
|||
29
README
29
README
|
|
@ -2,26 +2,27 @@ This are the scripts running on volkszaehler.org
|
|||
Feel free to setup your own installation and protect your privacy!
|
||||
|
||||
volkszaehler.org/
|
||||
|_ etc/ configuration files
|
||||
|_ debian metadata for debian packaging
|
||||
|_ htdocs/ static files accessible through the web
|
||||
| |_ middleware.php middleware bootstrapping
|
||||
| \_ frontend web frontend
|
||||
|
|
||||
|_ etc/ configuration files
|
||||
|_ var/ SQLite database (optional)
|
||||
|_ lib/ middleware libraries
|
||||
|_ misc/
|
||||
|_ controller/
|
||||
| |_ vzlogger/ command line tool to log meters/sensors
|
||||
| \_ batch/ batch scripts for logging (prototypes)
|
||||
|
|
||||
|_ docs/ documentation
|
||||
|_ frontend/
|
||||
|_ 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
|
||||
| |_ controller/
|
||||
| | |_ vzlogger/ command line tool to log meters/sensors
|
||||
| | \_ batch/ batch scripts for logging (prototypes)
|
||||
| |
|
||||
| |_ docs/ documentation
|
||||
| |_ frontend/
|
||||
| |_ 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
|
||||
\_ var/ SQLite database (optional)
|
||||
|
||||
Wiki: http://wiki.volkszaehler.org
|
||||
Other: http://volkszaehler.org
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
This directory contains PHP libraries by external developers or projects.
|
||||
This directory should contain external, third-party PHP libraries.
|
||||
|
||||
You can install them here, specify their location in etc/volkszaehler.conf.php
|
||||
or use PHP's include path.
|
||||
|
||||
Please consult the wiki for detailed instructions:
|
||||
|
||||
http://wiki.volkszaehler.org/howto/getstarted
|
||||
|
|
|
|||
Loading…
Reference in New Issue