Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ghoelian committed Apr 27, 2021
1 parent 079abbf commit 13a8bed
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,37 @@
# Weather Station

Simple weather station-esque program, written in Java with the Processing library. I was getting tired of my weather station constantly running out of batteries, and it running fast, so I made my own.

Made for a 480x800 display, have not tested scaling in any way.

## Install

### Prerequisites

- Java 8 ([Linux](https://openjdk.java.net/), [Windows](https://adoptopenjdk.net/?variant=openjdk8&jvmVariant=openj9))

You can get the latest release from the [releases](https://github.com/Ghoelian/WeatherStation/releases) page.

Copy ``data/variables.json.example`` to ``data/variables.json`` and edit it to include your own details. I haven't implemented proper error handling yet, so invalid values will crash the application.

### Windows

Simply run the executable.

### Linux

Make the WeatherStation file executable:

```sh
chmod +x WeatherStation
```

Then simply run the now executable file:

```sh
./WeatherStation
```

## Build

The easiest way to build the project is to use the Processing IDE. Simply load the project into the IDE, and click File->Export Application, then select your desired targets.
5 changes: 5 additions & 0 deletions data/variables.json.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"apiKey": "OpenWeatherMap API Key",
"email": "Email",
"city": "Amsterdam"
}

0 comments on commit 13a8bed

Please sign in to comment.