diff --git a/app/engine/Timer.js b/app/engine/Timer.js
index a750afe..3f6cffc 100644
--- a/app/engine/Timer.js
+++ b/app/engine/Timer.js
@@ -2,7 +2,7 @@
/*
Open Rowing Monitor, https://github.com/laberning/openrowingmonitor
- Stopwatch used to measure multiple time intevals
+ Stopwatch used to measure multiple time intervals
*/
function createTimer () {
const timerMap = new Map()
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..a2ff7f5
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-metadata
+Gemfile
+Gemfile.lock
diff --git a/README.md b/docs/README.md
similarity index 92%
rename from README.md
rename to docs/README.md
index 06e688f..4f7f702 100644
--- a/README.md
+++ b/docs/README.md
@@ -1,7 +1,7 @@
# Open Rowing Monitor
-
+
An open source rowing monitor for rowing exercise machines. It upgrades a rowing machine into a real smart trainer that can be used with training applications and games.
@@ -12,7 +12,7 @@ We suspect it works well with DIY rowing machines like the [Openergo](https://op
## Features
-The following items describe most of the current features, more functionality will be added in the future, check the [Development Roadmap](docs/backlog.md) if you are curious.
+The following items describe most of the current features, more functionality will be added in the future, check the [Development Roadmap](./backlog.md) if you are curious.
### Rowing Metrics
@@ -33,7 +33,7 @@ The web interface visualizes the rowing metrics on any device that can run a web
If you connect a screen to the Raspberry Pi, then this interface can also be directly shown on the device. The installation script can set up a web browser in kiosk mode that runs on the Raspberry Pi.
-
+
### Bluetooth Low Energy (BLE)
@@ -63,7 +63,7 @@ You will need a Raspberry Pi Zero W, Raspberry Pi Zero 2 W, Raspberry Pi 3 or a
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/laberning/openrowingmonitor/HEAD/install/install.sh)"
```
-Also have a look at the [Detailed Installation Instructions](docs/installation.md) for more information on the software installation and for instructions on how to connect the rowing machine.
+Also have a look at the [Detailed Installation Instructions](./installation.md) for more information on the software installation and for instructions on how to connect the rowing machine.
## How it all started
@@ -77,8 +77,8 @@ This project is already in a very usable stage, but some things are still a bit
Feel free to leave a message in the [GitHub Discussions](https://github.com/laberning/openrowingmonitor/discussions) if you have any questions or ideas related to this project.
-Check the advanced information on the [Physics behind Open Rowing Monitor](docs/physics_openrowingmonitor.md).
+Check the advanced information on the [Physics behind Open Rowing Monitor](./physics_openrowingmonitor.md).
-We plan to add more features, here is the [Development Roadmap](docs/backlog.md).
+We plan to add more features, here is the [Development Roadmap](./backlog.md).
-This project uses some great work by others, see the [Attribution here](docs/attribution.md).
+This project uses some great work by others, see the [Attribution here](./attribution.md).
diff --git a/docs/_config.yml b/docs/_config.yml
new file mode 100644
index 0000000..45894c7
--- /dev/null
+++ b/docs/_config.yml
@@ -0,0 +1,50 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: Open Rowing Monitor
+description: >- # this means to ignore newlines until "baseurl:"
+ A free performance monitor for rowing machines
+# baseurl: "" # the subpath of your site, e.g. /blog
+# url: "" # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: laberning
+github_username: laberning
+
+# Build settings
+markdown: kramdown
+theme: jekyll-theme-cayman
+plugins:
+ - jekyll-feed
+
+navigation:
+ - title: About
+ url: /
+ - title: Installation
+ url: /installation.html
+ - title: Physics
+ url: /physics_openrowingmonitor.html
+ - title: Backlog
+ url: /backlog.html
+
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+# exclude:
+# - Gemfile
+# - Gemfile.lock
+# - node_modules
+# - vendor/bundle/
+# - vendor/cache/
+# - vendor/gems/
+# - vendor/ruby/
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
new file mode 100644
index 0000000..b5c90f0
--- /dev/null
+++ b/docs/_layouts/default.html
@@ -0,0 +1,58 @@
+
+
+
+
+
+{% seo %}
+
+
+
+
+
+
+
+ {% include head-custom-google-analytics.html %}
+
+
+
+
+
+
+
An open source rowing monitor for rowing exercise machines. It upgrades a rowing machine into a real smart trainer that can be used with training applications and games.
@@ -12,7 +12,7 @@ We suspect it works well with DIY rowing machines like the [Openergo](https://op
## Features
-The following items describe most of the current features, more functionality will be added in the future, check the [Development Roadmap](docs/backlog.md) if you are curious.
+The following items describe most of the current features, more functionality will be added in the future, check the [Development Roadmap](./backlog.md) if you are curious.
### Rowing Metrics
@@ -33,7 +33,7 @@ The web interface visualizes the rowing metrics on any device that can run a web
If you connect a screen to the Raspberry Pi, then this interface can also be directly shown on the device. The installation script can set up a web browser in kiosk mode that runs on the Raspberry Pi.
-
