Progress writing documentation

This commit is contained in:
AlexSSD7 2023-09-03 10:22:53 +01:00
commit d01d3e3d10
4 changed files with 60 additions and 4 deletions

View file

@ -7,14 +7,14 @@ Here you will find the instructions on how you can install Linsk on macOS.
Linsk aims to have minimal dependencies. In this section, you can find the instructions to install the required dependencies. Linsk aims to have minimal dependencies. In this section, you can find the instructions to install the required dependencies.
## QEMU ## QEMU
QEMU powers the Linsk's virtual machine. This is the sole requirement. QEMU is what Linsk uses to run virtual machines.
The easiest way to install QEMU on macOS is to use `brew` package manager. The easiest way to install QEMU on macOS is to use `brew` package manager.
```sh ```sh
brew install qemu brew install qemu
``` ```
## (Optional) Go ## (Optional) Go v1.21 or higher
**OPTIONAL:** You need to install Go only if you want to use `go install` installation method or build Linsk from the bare Git repository. **OPTIONAL:** You need to install Go only if you want to use `go install` installation method or build Linsk from the bare Git repository.
You can find the installer on Go's official website: https://go.dev/dl/. You can find the installer on Go's official website: https://go.dev/dl/.

View file

@ -6,8 +6,12 @@ Here you will find the instructions on how you can install Linsk on Windows.
Linsk aims to have minimal dependencies. In this section, you can find the instructions to install the required dependencies. Linsk aims to have minimal dependencies. In this section, you can find the instructions to install the required dependencies.
## Enable virtualization
You will need to enable virtualization in your OS, and in most cases in BIOS too. This is required to run a virtual machine on your computer. You can find the instructions how to do it here: https://support.microsoft.com/en-us/windows/enable-virtualization-on-windows-11-pcs-c5578302-6e43-4b4b-a449-8ced115f58e1.
## QEMU ## QEMU
QEMU powers the Linsk's virtual machine. QEMU is what Linsk uses to run virtual machines.
The easiest way to install QEMU on Windows is to use the official installer binaries. You can find them here: https://www.qemu.org/download/#windows. The easiest way to install QEMU on Windows is to use the official installer binaries. You can find them here: https://www.qemu.org/download/#windows.
@ -16,7 +20,7 @@ Linsk takes use of OpenVPN's tap networking drivers to allow for direct host-VM
The easiest way to get these drivers is to use OpenVPN Community installer: https://openvpn.net/community-downloads/. The easiest way to get these drivers is to use OpenVPN Community installer: https://openvpn.net/community-downloads/.
## (Optional) Go ## (Optional) Go v1.21 or higher
**OPTIONAL:** You need to install Go only if you want to use `go install` installation method or build Linsk from the bare Git repository. **OPTIONAL:** You need to install Go only if you want to use `go install` installation method or build Linsk from the bare Git repository.
You can find the installer on Go's official website: https://go.dev/dl/. You can find the installer on Go's official website: https://go.dev/dl/.

33
LINUX_DEV_ENV.md Normal file
View file

@ -0,0 +1,33 @@
# Linsk on Linux
Yes, you read that right. For development purposes, Linsk remains 100% supported natively on Linux as well as on macOS and Windows. This makes it possible to lead the development on Linux without having to compromise the annoyance of any other operating systems.
# Prerequisites
## QEMU
On Ubuntu (and probably on any other Debian-based distro) you can install the required `qemu-system-$(arch)` binary by running the following:
```sh
apt install qemu-system
```
## Go v1.21 or higher
There are many installation options, but so far, the most convenient way to install it is to do so from the official website: https://go.dev/doc/install.
Since Linsk is written in Go (Golang), you will need to have a working Go environment to compile it.
# Build from Source
Clone the repository using `git` and run `go build` to build the Linsk binary.
```sh
git clone https://github.com/AlexSSD7/linsk
cd linsk
go build
```
After that is done, you will be able to find the `linsk` binary in the same directory you ran `go build` in.
# The next steps
That's it. You can follow the further usage instructions set in TODO just like with any other OS.

View file

@ -4,6 +4,25 @@ Linsk is a utility that allows you to access Linux-native file system infrastruc
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).
# Supported platforms
## 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.
## Operating systems
* Windows
* macOS
* Linux (for development purposes, mostly)
## 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:
* SMB - The default for Windows.
* AFP - The default for macOS.
* FTP - An alternative backend.
# Installation # Installation
//TODO //TODO