README.md 4.29 KB
Newer Older
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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
# Rabenwetter
**A [weeWX](http://weewx.com/) skin for [rabenwetter.de](https://rabenwetter.de)**  
  
  
## Introduction / Warning
While this is in production use on [rabenwetter.de](https://rabenwetter.de) 
already, it's still kinda messy and you should expect bugs. Only use it, if 
you're willing to spend a few hours on this...  
I will eventually update and really release it, when it's ready, but it's not, yet...  
  
  
## Demo
See this skin in action at [rabenwetter.de](https://rabenwetter.de)  
  
  
## Installation
* **Copy `dist/*` to a new folder inside your weewx `skins` directory.**  
> **Example:**  
> `cp -r website_rabenwetter/dist/* /etc/weewx/skins/Rabenwetter/`

* **Apply supplied patch.**  
> **Example:**  
> `patch -p1 /usr/share/weewx/weewx/cheetahgenerator.py website_rabenwetter/cheetahgenerator.patch`  
> 
> This patch adds the ability to append week numbers to archive filenames, 
> which is needed for the graphs on the archive page.  
> **As of weeWX v3.8.0, you will need to reapply this patch everytime, you're 
> updating your weewx version!**  
>  
> The patch has already been [merged with the development branch](https://github.com/weewx/weewx/pull/319) 
> of weewx, so it will be included with future releases of weeWX, rendering 
> this step useless in the future. I'll update this readme accordingly.  
  
* **Edit `skin.conf` according to your system.**  
> **Example:**  
> `vim /etc/weewx/skins/Rabenwetter/skin.conf`

* **Edit `info.html.tmpl` and `contact.html.tmpl` according to your needs.**  

* **Edit `weewx.conf` to use the new skin.**  
Look for the parameter `"skin"` below the section `"[[StandardReport]]"` and 
change it to `"Rabenwetter"`  
> **Example:**  
> `[[StandardReport]]`  
> `  skin = Rabenwetter`  
  
* **Webcam(s) (optional)**  
This skin can make use of up to two webcams. If you don't have of want them, 
simply delete or comment the corresponding configuration parameters from the 
included `skin.conf`.  
If, however, you ARE running a webcam, you may also take a look 
at some scripts, I wrote for several different types of webcams playing nice 
with this template: https://gitlab.ambhost.net/stimpy/scripts_webcam
  
  
## Development
### Initial dependencies
* [npm](https://nodejs.org/en/)

### Install remaining dependencies:

> `~# npm install`  
> `~# bower install`

### Sources
All development is done inside the folder `src/`. It's done in a way, so you 
can use the `src` folder as webroot on your development webserver.  
There will be some errors with weewx variables and logic bits, but it works 
good enough to see, what you're doing without having to render it through 
weewx everytime. 

### Distribution
Use grunt to create a usable weeWX skin inside the folder `dist/`:

> `~# grunt`  
  
  
## Updates  
You can always find the latest version of this 
[at my gitlab](https://gitlab.ambhost.net/stimpy/website_rabenwetter).  


## License
This template is licensed under the MIT License. Please see included 
[`LICENSE`](https://gitlab.ambhost.net/stimpy/website_rabenwetter/blob/master/LICENSE) 
file for details.  
However, the used [DevExtreme](https://js.devexpress.com/) library isn't. 
So this template is for non-commercial use only! (Or, you'll have to buy a license from them..) Please see included 
[`DXEULA`](https://gitlab.ambhost.net/stimpy/website_rabenwetter/blob/master/DXEULA) 
file for details.  
  
  
## 3rd party licenses
* **[jQuery](https://jquery.com):** [Proprietary](https://github.com/jquery/jquery/blob/master/LICENSE.txt)
* **[Bootstrap](https://getbootstrap.com):** [MIT License](https://github.com/twbs/bootstrap/blob/v3.4.0-dev/LICENSE)
* **[Bootstrap Datepicker](https://github.com/eternicode/bootstrap-datepicker):** [Apache License 2.0](https://github.com/uxsolutions/bootstrap-datepicker/blob/master/LICENSE)
* **[jQuery Zoom](http://jacklmoore.com/zoom/):** [MIT License](https://github.com/jackmoore/zoom/blob/master/LICENSE.md)
* **[DevExtreme](https://js.devexpress.com/):** [Proprietary](https://js.devexpress.com/EULAs/DevExtremeNonCommercial/)
* **[DSDIGI Font](http://ds-font.hypermart.net):** [Proprietary](https://gitlab.ambhost.net/stimpy/website_rabenwetter/blob/master/DSDIGI)
* **[Leagure Gothic Font](https://www.fontsquirrel.com/fonts/League-Gothic):** [SIL](https://gitlab.ambhost.net/stimpy/website_rabenwetter/blob/master/LEAGUEGOTHIC)