mirror of
https://github.com/MarekWo/mc-webui.git
synced 2026-03-28 17:42:45 +01:00
docs: Reorganize Prerequisites section and fix references
- Move device preparation from Installation step 0 to Prerequisites - Restructure Prerequisites into logical sections: 1. Meshcore Device setup (flashing and configuration) 2. Linux Server requirements (git, Docker) - Replace wiki.wojtaszek.it link with local DOCKER_INSTALL.md reference - Remove Installation step 0, renumber steps to start from 1 - Fix typo: "can used" -> "can use" (line 121) - Improve readability with "Before starting, ensure you have:" intro 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
27
README.md
27
README.md
@@ -58,24 +58,27 @@ A lightweight web interface for meshcore-cli, providing browser-based access to
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Docker** and **Docker Compose** installed ([installation guide](https://wiki.wojtaszek.it/pl/home/apps/docker/installation))
|
||||
- **Meshcore device** connected via USB (tested on Heltec V4)
|
||||
Before starting, ensure you have:
|
||||
|
||||
**1. Meshcore Device (tested on Heltec V4)**
|
||||
- **Flash the device** at [https://flasher.meshcore.co.uk/](https://flasher.meshcore.co.uk/). Choose the `Companion USB` role.
|
||||
- **Configure the device** with the Meshcore mobile app (from Google Play Store / App Store):
|
||||
- Name
|
||||
- Location (optional)
|
||||
- Preset
|
||||
|
||||
**2. Linux Server**
|
||||
- **Git** installed
|
||||
- **Docker** and **Docker Compose** installed ([installation guide](DOCKER_INSTALL.md))
|
||||
|
||||
**Important Notes:**
|
||||
- ✅ **No meshcore-cli installation required on host** - meshcore-cli is automatically installed inside the Docker container
|
||||
- ✅ **No manual directory setup needed** - all data is stored in `./data/` inside the project directory
|
||||
- ✅ **meshcore-cli version 1.3.12+** is automatically installed for proper Direct Messages (DM) functionality
|
||||
|
||||
---
|
||||
|
||||
### Installation
|
||||
0. **Prepare the device**
|
||||
- **Flash the device** at [https://flasher.meshcore.co.uk/](https://flasher.meshcore.co.uk/). Choose the `Companion USB` role.
|
||||
- **Configure the device** with the Meshcore mobile app (from Google Play Store / App Store).
|
||||
- Name
|
||||
- Location (optional)
|
||||
- Preset
|
||||
- **Install / prepare your Linux server**. You will need the following elements installed:
|
||||
- git
|
||||
- docker (you may want [to check this Docker installation guide](DOCKER_INSTALL.md))
|
||||
|
||||
1. **Clone the repository**
|
||||
```bash
|
||||
@@ -115,7 +118,7 @@ A lightweight web interface for meshcore-cli, providing browser-based access to
|
||||
cp .env.example .env
|
||||
|
||||
# Edit configuration
|
||||
nano .env # or you can used your favorite text editor
|
||||
nano .env # or you can use your favorite text editor
|
||||
```
|
||||
|
||||
**Required changes in .env:**
|
||||
|
||||
Reference in New Issue
Block a user