From db9ebc25c9b22478e63fb9d488fcec049c2eefc2 Mon Sep 17 00:00:00 2001 From: Anton Roslund Date: Tue, 18 Feb 2025 00:14:44 +0100 Subject: [PATCH] Updated README --- README.md | 30 ++++++++++++------------------ 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 47b7422..4da63ae 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,33 @@ # STHLM-MESH -https://sthlm-mesh.se är statik sida byggd med [Hugo][] och avnänder [Docsy][] som tema. -Sidan riktar sig till LoRa mesh teknoligi i stockholms området. Primärt fokus är [Meshtastic][] , men vi är öppna för andra teknologier. +**[STHLM-MESH](https://sthlm-mesh.se)** är webbsida byggd med [Hugo][] och avnänder [Docsy][] som tema. +Sidan riktar sig till de som är intreserade av LoRa mesh teknoligi i allmenhet. Med huvudfokus är det [Meshtastic][] mesh i som omfattar stockholms området. -Innehållet skrivs på svenska eller svengelska. Sidan har stöd för multipla språk, men det är inget vi är redo att utforska än. +Innehållet skrivs på svenska eller svengelska. Sidan har stöd för flera språk, men att översätta innehållet till engelska är inte prioriterat, då det finns redan massvis med information om Meshtastic på engeskla. Sidan är hostad genom _GitHub Pages_ och en GitHub Action uppdaterar sidan vid varje commit till `main` barnchen. -## Contributing + +## Bidra till projektet Vi välkomnar om man vill dela med sig av tips & triks, best practises eller guider. Sidans inntehåll finns i mappen `content`. Innehållet är i markdown och borde vara relativt tillgängligt att uppdatera. Själva dokumentationen finns under `content/sv/docks/`, det är primärt där vi önskar förslag på innehåll. -## Running a container locally -You can run docsy-example inside a [Docker](https://docs.docker.com/) -container, the container runs with a volume bound to the `docsy-example` -folder. This approach doesn't require you to install any dependencies other -than [Docker Desktop](https://www.docker.com/products/docker-desktop) on -Windows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/) -on Linux. +## Lokal utvekling i en container +Webbsidan kan enkelt köras inuti en [Docker](https://docs.docker.com/)-container. Detta kräver endast installation av [Docker Desktop](https://www.docker.com/products/docker-desktop) på Windows och Mac, samt [Docker Compose](https://docs.docker.com/compose/install/) på Linux. -1. Build the docker image + +1. Bygg containern ```bash docker-compose up --build ``` -1. Verify that the service is working. +1. Öppna en webbläsare och anslut till `http://localhost:1313` - Open your web browser and type `http://localhost:1313` in your navigation bar, - This opens a local instance of the docsy-example homepage. You can now make - changes to the docsy example and those changes will immediately show up in your - browser after you save. +1. Du kan nu göra förändringar på innehållet och du ska direkt se resultatet i din webbläsare när du sparat. -For more information see the [Docker Compose documentation][]. +För mer information, se [Docker Compose documentation][]. [Meshtastic]: http://meshtastic.org/ [Docsy]: https://github.com/google/docsy