Added Nix, flake , better readme, and docs

update readme and divised them in mutliple files in a news directory names `docs`  with two folder for localized versions, added nix flake and removed obseleted scripts
This commit is contained in:
xgui4
2026-05-17 13:57:29 -04:00
parent 9f133c963f
commit cfa861b357
9 changed files with 270 additions and 182 deletions

58
docs/en/COMPILING.md Normal file
View File

@@ -0,0 +1,58 @@
# How to build
## Portable Nuitka Build
0. Create a Python Virtual Env via a tool like UV (if not already done)
1. Run `hatch run packages`
### Arch Linux
1. Go the [`packages/linux` directory](packages/linux)
2. Choose a channel dev, nigthly or stable (go to the directory)
3. Run `makepkg -si` or `makepkg -s` (for no install) in one of these directory
### Nix Package
<!--
#### Nix Flake (Coming Soon)
Run `nix build`
-->
#### Nixpkg
```bash
if [[ $user_input == "install" ]]; then
nix-build default.nix
nix-env -i ./result
fi
if [[ $user_input == "compile" ]]; then
./scripts/build.sh
fi
if [[ $user_input == "clear" ]]; then
./scripts/clear.sh
fi
```
#### Windows Installer
Requirements :
[Inno Setup 6.6+](https://jrsoftware.org/isdl.php)
1. Go to the windows packages locations : `cd pacakges/windows`
2. run the script with Inno Setup for your desired channel [`setup-nightly.iss`](packages/windows/setup-nigthly.iss) or [`setup.iss`](packages/windows/setup.iss))
#### FreeBSD
1. go to the freebsd port folder : `cd freebsd-ports`
2. run the install scripts : `install`
#### Flatpak
> [!NOTE]
> For Flatpak, manual building is only recommended for development purposes or for forks that don't have a Flatpak repository.
> Currently, this is the only method since the official Flatpak repository is not yet activated. Once activated, this part of the notice will be removed, and it will then be recommended to use the Flatpak repository, which will be displayed here.
1. Go to the flatpak manifest location : `cd packages/flatpak`
2. Build the flatpak : `flatpak-builder --user --install build-dir io.github.xgui4.lce_qt_launcher.yml --install-deps-from=flathub`

43
docs/en/RUNNING.md Normal file
View File

@@ -0,0 +1,43 @@
# How to run
## VSCode
> [!NOTE]
> In Windows you might need to replace `/` with `\`
> [!WARNING]
> This method is not recommed nore tested for NixOS, go to the NixOS Section, for the step for this particular OS.
1. Create a Python Virtual Env via a tool like UV (if not already done)
2. Set VSCode to that Python Virtual Env
3. Run "Pyside : Sync Virtual Env and Launch"
4. Run the app via Vscode debug mode or directly the [`src/lce_qt_launcher/main.py`](src/lce_qt_launcher/main.py) file.
## NixOS
1. load the nix shell with `nix-shell` command
2. compiled the ui and ressource file with [`scripts/build.sh`](scripts/build.sh)
3. load the app with [`python src/lce_qt_launcher/main.py`](src/lce_qt_launcher/main.py)
## FreeBSD
```shell
#!/usr/bin/env sh
if [ "$1" = "create-venv" ]; then
uv venv --system-site-packages
fi
if [ "$1" = "sync" ]; then
uv sync --system-certs
fi
```
## Using the command line
1. Create the venv with uv (`uv sync`)
2. Load the venv with `source .venv/bin/activate.sh` (replace .sh with your shell, on Windows it is `.venv\Scripts\activate.ps1` for powershell or `.venv\Scripts\activate.bat` for cmd)
3. Run `scripts/build.sh` (for Linux) `scripts\build.cmd` for (Windows)
4. Run the main python script `src/lce_qt_launche.py` (On Windows you might need to invoque `python3` directly and replace `/` with `\`)

62
docs/fr/COMPILATION.md Normal file
View File

@@ -0,0 +1,62 @@
# Comment compiler
## Compilation portable de Nuitka
0. Créez un environnement virtuel Python avec un outil comme UV (si ce n'est pas déjà fait).
1. Exécutez `hatch run packages`.
### Arch Linux
1. Accédez au répertoire `packages/linux`.
2. Choisissez un canal : dev, nightly ou stable (accédez au répertoire correspondant).
3. Exécutez `makepkg -si` ou `makepkg -s` (pour une installation sans modification) dans l'un de ces répertoires.
### Paquet Nix
<!--
#### Nix Flake (Bientôt disponible)
Exécutez `nix build`.
-->
#### Nixpkg
```bash
if [[ $user_input == "install" ]]; then
nix-build default.nix
nix-env -i ./result
fi
if [[ $user_input == "compile" ]]; puis
./scripts/build.sh
fi puis
./scripts/clear.sh
fi
```
#### Programme d'installation Windows
Prérequis :
[Inno Setup 6.6+](https://jrsoftware.org/isdl.php)
1. Accédez au répertoire des paquets Windows : `cd packages/windows`
2. Exécutez le script avec Inno Setup pour le canal souhaité : [`setup-nightly.iss`](packages/windows/setup-nightly.iss) ou [`setup.iss`](packages/windows/setup.iss)
#### FreeBSD
1. Accédez au répertoire des ports FreeBSD : `cd freebsd-ports`
2. Exécutez le script d'installation : `install`
#### Flatpak
> [!NOTE]
> Pour Flatpak, la compilation manuelle est recommandée uniquement à des fins de développement ou pour les forks ne disposant pas de dépôt Flatpak.
> Actuellement, il s'agit de la seule méthode disponible, le dépôt Flatpak officiel n'étant pas encore activé. Une fois activé, cette partie de l'annonce sera supprimée et il sera alors recommandé d'utiliser le dépôt Flatpak, qui sera affiché ici.
1. Accédez au répertoire contenant le manifeste Flatpak : `cd packages/flatpak`
2. Compilez Flatpak : `flatpak-builder --user --install build-dir io.github.xgui4.lce_qt_launcher.yml --install-deps-from=flathub`

43
docs/fr/UTILISATION.md Normal file
View File

@@ -0,0 +1,43 @@
# Comment exécuter
## VSCode
> [!NOTE]
> Sous Windows, vous devrez peut-être remplacer `/` par `\`.
> [!WARNING]
> Cette méthode n'est ni recommandée ni testée pour NixOS. Consultez la section NixOS pour connaître la procédure spécifique à ce système d'exploitation.
1. Créez un environnement virtuel Python à l'aide d'un outil comme UV (si ce n'est pas déjà fait).
2. Configurez VSCode pour utiliser cet environnement virtuel Python.
3. Exécutez « Pyside : Synchroniser l'environnement virtuel et lancer ».
4. Lancez l'application via le mode débogage de VSCode ou directement le fichier [`src/lce_qt_launcher/main.py`](src/lce_qt_launcher/main.py).
## FreeBSD
```shell
#!/usr/bin/env sh
if [ "$1" = "create-venv" ]; then
uv venv --system-site-packages
fi
if [ "$1" = "sync" ]; then
uv sync --system-certs
fi
```
## NixOS
1. Lancez le shell Nix avec la commande `nix-shell`.
2. Compilez l'interface utilisateur et le fichier de ressources avec `scripts/build.sh`.
3. Chargez l'application avec `python src/lce_qt_launcher/main.py`.
## Utilisation de la ligne de commande
1. Créez l'environnement virtuel (venv) avec uv (`uv sync`).
2. Chargez le venv avec `source .venv/bin/activate.sh` (remplacez `.sh` par votre shell : sous Windows, `.venv\Scripts\activate.ps1` pour PowerShell ou `.venv\Scripts\activate.bat` pour l'invite de commandes).
3. Exécutez `scripts/build.sh` (pour Linux) ou `scripts\build.cmd` (pour Windows).
4. Exécutez le script Python principal. `src/lce_qt_launche.py` (Sous Windows, vous devrez peut-être invoquer directement `python3` et remplacer `/` par `\`)