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

Progress writing README

Browse source
This commit is contained in:
AlexSSD7 2023-09-02 20:54:58 +01:00
commit 58fc7ed00b
3 changed files with 144 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

51
INSTALL_MACOS.md Normal file
View file

@ -0,0 +1,51 @@
# Linsk installation instructions for macOS
Here you will find the instructions on how you can install Linsk on macOS.
# Prerequisites
Linsk aims to have minimal dependencies. In this section, you can find the instructions to install the required dependencies.
## QEMU
QEMU powers the Linsk's virtual machine. This is the sole requirement.
The easiest way to install QEMU on macOS is to use `brew` package manager.
```sh
brew install qemu
```
## (Optional) Go
**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/.
# Installation
## Using Go's `go install`
Assuming that you have an existing Go installation, you should be able to access the `go install` command which will build the project from source and put it to `$GOPATH/bin` directory. By default, `$GOPATH` is `$HOME/go`.
You can run the following command to build and install Linsk:
```sh
go install github.com/AlexSSD7/linsk
```
After that, you should be able to run `linsk`, or `~/go/bin/linsk` if you have not added `~/go/bin` to `$PATH`.
## Package managers
//TODO.
## Prebuilt binaries
//TODO.
## 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.