chore: update readme, move files around

ugomeda · Jan 27, 2025 · 71d875c · 71d875c
1 parent 952b771
commit 71d875c
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -12,8 +12,12 @@ screenshot it and generate a PNG which can be sent to the Inkplate 10.
 
 ### Docker quickstart
 
+An image is provided on [dockerhub](https://hub.docker.com/r/ugomeda/inkplate-dashboard):
+
 ```
-docker run -v $(pwd)/config.example.toml:/app/config.toml:ro \
+docker run \
+    --pull always \
+    -v $(pwd)/config.example.toml:/app/config.toml:ro \
     -p 8000:8000 \
     ugomeda/inkplate-dashboard:latest
 ```
@@ -23,7 +27,7 @@ Then access:
 - Live HTML version: http://localhost:8000/live/html
 - Live PNG version: http://localhost:8000/live/png
 
-### Quick setup
+### Run locally
 
 For a local setup, you will need Google Chrome or Chromium installed
 on your machine.
@@ -48,13 +52,11 @@ You should be able to access the dashboard on the following URLs:
 
 Note: if chrome is not found, update the paths in `inkplate_dashboard/chrome.py`
 
-### Docker setup
+## Assets
 
-You can also build the image locally:
+This projets uses:
 
-```
-docker build -t inkplate_dashboard .
-docker run -v $(pwd)/config.example.toml:/app/config.toml:ro \
-    -p 8000:8000 \
-    inkplate_dashboard
-```
+- Weather icons: https://github.com/nrkno/yr-weather-symbols
+- Icons: https://github.com/feathericons/feather
+- textFit: https://github.com/STRML/textFit
+- Fonts: https://github.com/fontsource
diff --git a/inkplate_dashboard/statics/icons/feather/LICENSE b/inkplate_dashboard/statics/icons/feather/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2023 Cole Bemis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/...ashboard/statics/icons/feather-sprite.svg → .../statics/icons/feather/feather-sprite.svg b/...ashboard/statics/icons/feather-sprite.svg → .../statics/icons/feather/feather-sprite.svg
diff --git a/inkplate_dashboard/statics/js/textfit/LICENSE b/inkplate_dashboard/statics/js/textfit/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2023 Cole Bemis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/inkplate_dashboard/statics/js/textFit.min.js → ...shboard/statics/js/textfit/textFit.min.js b/inkplate_dashboard/statics/js/textFit.min.js → ...shboard/statics/js/textfit/textFit.min.js
diff --git a/inkplate_dashboard/templates/display.html b/inkplate_dashboard/templates/display.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8">
     <title>Inkplate 10 display</title>
     <link rel="stylesheet" type="text/css" href="/static/styles.css">
-    <script src="/static/js/textFit.min.js"></script> 
+    <script src="/static/js/textfit/textFit.min.js"></script> 
   </head>
   <body>
     <div id="display">

diff --git a/inkplate_dashboard/templates/widget-weather.html b/inkplate_dashboard/templates/widget-weather.html
@@ -6,13 +6,13 @@
             <div class="widget-weather-current-temperature">{{ weather[0].temperature }}</div>
             <div>
                 <svg fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
-                    <use href="/static/icons/feather-sprite.svg#wind" />
+                    <use href="/static/icons/feather/feather-sprite.svg#wind" />
                 </svg> {{ weather[0].wind }}
             </div>
             {% if weather[0].rain %}
             <div>
                 <svg fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
-                    <use href="/static/icons/feather-sprite.svg#umbrella" />
+                    <use href="/static/icons/feather/feather-sprite.svg#umbrella" />
                 </svg> {{ weather[0].rain }}
             </div>
             {% endif %}