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

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.