Added readme

This commit is contained in:
Nicolai Ort 2021-04-14 17:30:48 +02:00
parent 046962d6f4
commit 866d0c6396
1 changed files with 25 additions and 0 deletions

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# @lfk/scanclient-ive
## ✒️ Overview
This is the a live linux distribution that autostarts @lfk/scanclient-electron after boot.
Based on the awesome [Slax Linux](https://www.slax.org/).
## 🚀 Setup
1. Download the latest zip and unpack it
2. Copy the slax folder over to your USB drive
3. Execute the `slax/boot/bootinst.bat` (Windows) or `slax/boot/bootinst.sh` (Linux) Skript to make the usb bootable
4. Boot your system from the usb stick (legacy mode)
## 🛠 Build it yourself
> These steps rely on node:alpine, you can adopt them to your own os (mostly for depency installation)
```bash
apk add squashfs-tools git zip
yarn
yarn download
unsquashfs slax/modules/lfkscan.sb
rm -rf slax/modules/lfkscan.sb squashfs-root/root/lfkscan
mv out/\@lfk-scanclient-electron-linux-x64 squashfs-root/root/lfkscan
mksquashfs squashfs-root slax/modules/lfkscan.sb -b 1024k -comp xz -Xbcj x86 -e boot
rm -rf squashfs-root out electron.zip
zip -r dist/lfk-scanclient-live_custom_x64.zip slax
```