forks/linsk
forks/linsk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README.md updates

Browse source
This commit is contained in:
AlexSSD7 2023-09-03 15:25:44 +01:00
commit cdef5eebce
1 changed files with 17 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,41 +1,43 @@
# Linsk # Linsk
Linsk is a utility that allows you to access Linux-native file system infrastructure, including LVM and LUKS on Windows and macOS. Unlike other solutions created to access Linux filesystems on unsupported operating systems, Linsk does not reimplement any file system. Instead, Linsk utilizes a lightweight Alpine Linux VM (~130 MB only) combined with network share technologies like SMB, AFP, and FTP. **Linsk** is a utility that allows you to access Linux-native file system infrastructure, including LVM and LUKS on Windows and macOS. Unlike other solutions created to access Linux filesystems on unsupported operating systems, Linsk does not reimplement any file system. Instead, Linsk utilizes a lightweight Alpine Linux VM (~130 MB only) combined with network share technologies like SMB, AFP, and FTP.
Because Linsk uses a native Linux VM, there are no limitations on what you can access. Anything that works on Linux will work under Linsk too (hence the Linux+Disk name). Because Linsk uses a native Linux VM, there are no limitations on what you can access. Anything that works on Linux will work under Linsk too (hence the Linux+Disk name).
<!-- TODO: Telegram chat --> <!-- TODO: Telegram chat -->
# Supported platforms # 💻 Supported platforms
## CPU architectures ## CPU architectures
Linsk natively supports both amd64 (aka x86_64, Intel, AMD, etc.) and arm64 (aka aarch64, Apple M1/M2, and others). Although Linsk uses a virtual machine, CPU is never emulated but hardware accelerators like HVF (macOS), WHPX (Windows), and KVM (Linux) are used. Linsk natively supports both **x86_64** (aka amd64, Intel, AMD, etc.) and **aarch64** (aka arm64, Apple M1/M2, and others).
Although Linsk uses a virtual machine, the CPU is never emulated but the hardware accelerators like HVF (macOS), WHPX (Windows), and KVM (Linux) are used.
## Operating systems ## Operating systems
* Windows * **Windows**
* macOS * **macOS**
* Linux (for development purposes, mostly) * **Linux** (for development purposes, mostly)
## Network file share backends ## Network file share backends
Linsk relies on network file shares to expose files to the host machine. Below are the types of network shares Linsk supports: Linsk relies on network file shares to expose files to the host machine. Below are the types of network shares Linsk supports:
* SMB - The default for Windows. * **SMB** - The default for Windows.
* AFP - The default for macOS. * **AFP** - The default for macOS.
* FTP - An alternative backend. * **FTP** - An alternative backend.
# Installation # 💿 Installation
- Windows: See [INSTALL_WINDOWS.md](INSTALL_WINDOWS.md). - **Windows** - See [INSTALL_WINDOWS.md](INSTALL_WINDOWS.md).
- macOS: See [INSTALL_MACOS.md](INSTALL_MACOS.md) - **macOS** - See [INSTALL_MACOS.md](INSTALL_MACOS.md).
- Linux (development purposes, mostly): Refer to [LINUX_DEV_ENV.md](LINUX_DEV_ENV.md). - **Linux** - Refer to [LINUX_DEV_ENV.md](LINUX_DEV_ENV.md).
# Contributing # 👨‍💻 Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md). Please see [CONTRIBUTING.md](CONTRIBUTING.md).
# Copyright and License # ©️ Copyright and License
Copyright (c) 2023 The Linsk Authors. Copyright (c) 2023 The Linsk Authors.