Difference between revisions of "GNUrc"
(→/etc: link to download script...) |
(→Directory Structure: working on directory structure...) |
||
Line 74: | Line 74: | ||
=== Directory Structure === | === Directory Structure === | ||
− | The software has the following directory structure starting in the [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/?root=remotecontrol | + | The software has the following directory structure starting in the [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/?root=remotecontrol base]: |
==== / ==== | ==== / ==== | ||
+ | |||
+ | The base directory is /path/to/your/gnurc. | ||
* [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/.svn-ignore?root=remotecontrol&view=markup .svn-ignore] -- files for Subversion (svn) to ignore | * [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/.svn-ignore?root=remotecontrol&view=markup .svn-ignore] -- files for Subversion (svn) to ignore | ||
Line 85: | Line 87: | ||
==== /dat ==== | ==== /dat ==== | ||
+ | |||
+ | The dat directory is for data files. | ||
* [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/dat/lang.dat?root=remotecontrol&view=markup lang.dat] -- the [http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry language subtag registry] | * [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/dat/lang.dat?root=remotecontrol&view=markup lang.dat] -- the [http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry language subtag registry] | ||
Line 90: | Line 94: | ||
==== /etc ==== | ==== /etc ==== | ||
+ | |||
+ | The etc directory is for miscellaneous scripts. | ||
* [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/etc/download-language-data.sh?root=remotecontrol&view=markup download-language-data.sh] -- downloads the [[#/dat|lang.dat]] file | * [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/etc/download-language-data.sh?root=remotecontrol&view=markup download-language-data.sh] -- downloads the [[#/dat|lang.dat]] file | ||
+ | |||
+ | ==== /src ==== | ||
+ | |||
+ | The src directory is for most of the source code. | ||
+ | |||
+ | * [http://svn.savannah.gnu.org/viewvc/branches/development/jj5-mvc/src/include.php?root=remotecontrol&view=markup include.php] -- the main include file for loading the GNUrc software components. | ||
+ | |||
+ | ==== /src/class === | ||
+ | |||
+ | The src/class directory | ||
=== Web Interface === | === Web Interface === |
Revision as of 05:14, 9 April 2015
GNUrc is the GNU Remote Control software. That's the software that aids in the maintenance of your thermostats. For other projects see projects.
Status
v1.1 released, v2.0 under development.
Motivation
To seek operational efficiencies in air-conditioners thereby saving electricity and improving comfort.
Administration
Contributors
Members who have contributed to this project. Newest on top.
All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.
Upstream (GNU) contributors: GNU Remote Control Contributors
Copyright
Copyright 2015, Contributors.
License
Licensed under the AGPL.
Resources
Downloads
See the home page for downloads.
Source code
See the home page for source code.
Links
- www.gnurc.com, the GNUrc developer portal
Specifications
Functional specification
The functional specification describes what the project does.
Administration Dashboard
The Administration Dashboard is an administrator's home page. From the Administration Dashboard an administrator can access:
- User Administration
- Language Administration
- Group Administration
- Error Reporting
User Administration
Language Administration
Group Administration
Error Reporting
Error Log Testing
Technical specification
The technical specification describes how the project works.
Directory Structure
The software has the following directory structure starting in the base:
/
The base directory is /path/to/your/gnurc.
- .svn-ignore -- files for Subversion (svn) to ignore
- e.g.: $ svn propset svn:ignore -RF .svn-ignore .
- config.example.php -- an example config file
- config.php -- the production config file
- e.g.: $ cp config.example.php config.php; vim config.php
/dat
The dat directory is for data files.
- lang.dat -- the language subtag registry
- lang.ser -- the serialized PHP data-structure of the processed lang.dat file.
/etc
The etc directory is for miscellaneous scripts.
- download-language-data.sh -- downloads the lang.dat file
/src
The src directory is for most of the source code.
- include.php -- the main include file for loading the GNUrc software components.
= /src/class
The src/class directory
Web Interface
admin-home.php
The admin-home.php
Notes
Notes for implementers
If you are interested in incorporating this software into your project, here's what you need to know:
Notes for developers
If you're looking to set up a development environment for this project here's what you need to know:
Tasks
TODO
Things to do, in rough order of priority:
- Document system design
- Generate task list
- Allocate tasks to developers
Done
Stuff that's done. Latest stuff on top.
- JE 2015-04-01: created project page