docs(README): update README

This commit is contained in:
2026-01-03 17:16:41 -06:00
parent 96f3f527f4
commit 184f0dbf14
4 changed files with 16 additions and 4 deletions

View File

@@ -3,6 +3,7 @@
> [!IMPORTANT]
> v4 coming soon with release builds for Linux and Windows. As well as updated container images and wheel packages.
For issues contact me over LXMF: `73
[![CI](https://git.quad4.io/RNS-Things/MeshChatX/actions/workflows/ci.yml/badge.svg?branch=master)](https://git.quad4.io/RNS-Things/MeshChatX/actions/workflows/ci.yml)
[![Tests](https://git.quad4.io/RNS-Things/MeshChatX/actions/workflows/tests.yml/badge.svg?branch=master)](https://git.quad4.io/RNS-Things/MeshChatX/actions/workflows/tests.yml)
[![Build](https://git.quad4.io/RNS-Things/MeshChatX/actions/workflows/build.yml/badge.svg?branch=master)](https://git.quad4.io/RNS-Things/MeshChatX/actions/workflows/build.yml)
@@ -218,9 +219,10 @@ We use [Task](https://taskfile.dev/) for automation.
| `task android-prepare` | Prepare Android build |
| `task android-build` | Build Android APK |
| `task build-flatpak` | Build Flatpak package |
| `task forge-start` | Run the application with Electron Forge |
| `task forge-make` | Generate distributables with Electron Forge |
| `task clean` | Clean build artifacts and dependencies |
## Security
- [ASAR Integrity](https://www.electronjs.org/docs/latest/tutorial/asar-integrity) (Electron 39)

View File

@@ -63,8 +63,8 @@ tasks:
lint-python:
desc: Lint Python code using ruff
cmds:
- poetry run ruff check . --exclude tests
- poetry run ruff format --check . --exclude tests
- poetry run ruff check meshchatx tests scripts --exclude tests/frontend --exclude .pnpm-store
- poetry run ruff format --check meshchatx tests scripts --exclude tests/frontend --exclude .pnpm-store
lint-frontend:
desc: Lint frontend code

View File

@@ -27,6 +27,7 @@ export default [
"**/*.proto",
"**/tests/**",
"**/tests/frontend/**",
"**/.pnpm-store/**",
],
},
{

View File

@@ -58,6 +58,9 @@ class DocsManager:
if self.project_root:
search_paths.append(os.path.join(self.project_root, "docs"))
# Also try in the public directory
search_paths.append(os.path.join(self.public_dir, "meshchatx-docs"))
# Also try relative to this file
# This file is in meshchatx/src/backend/docs_manager.py
# Project root is 3 levels up
@@ -81,7 +84,13 @@ class DocsManager:
if file.endswith(".md") or file.endswith(".txt"):
src_path = os.path.join(src_docs, file)
dest_path = os.path.join(self.meshchatx_docs_dir, file)
shutil.copy2(src_path, dest_path)
# Only copy if source and destination are different
if (
os.path.abspath(src_path) != os.path.abspath(dest_path)
and os.access(self.meshchatx_docs_dir, os.W_OK)
):
shutil.copy2(src_path, dest_path)
# Also pre-render to HTML for easy sharing/viewing
try: