GitHubMirror/MUTN
1
0
Fork 0
mirror of https://github.com/rwinkhart/MUTN.git synced 2026-08-28 04:46:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

[wiki/MUTN] Add basic building/installation instructions

Browse Source
This commit is contained in:
RandyTheSilly
2024-07-07 22:59:55 -04:00
parent 995e2bd982
commit 565f869da1
8 changed files with 153 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
wiki/MUTN/build.md
+12
View File
@@ -0,0 +1,12 @@
## Building
This repository is currently home to both the MUTN client and the general libmutton server software.
Official binaries are stripped of debug info for size and built without CGO (except for distribution packages) for portability, as follows:
```
CGO_ENABLED=0 go build -ldflags="-s -w" -trimpath ./mutn.go
CGO_ENABLED=0 go build -ldflags="-s -w" -trimpath ./libmuttonserver.go
```
Additionally, some custom build tags can be used to create different binaries. The following tags are not used in official builds:
- `wsl`: Allows creating a Linux binary that can interact with the Windows clipboard (for WSL)
- `termux`: Allows creating a Linux binary that can interact with the Termux clipboard (for Android)
wiki/MUTN/completions.md
+2 -2
View File
@@ -1,6 +1,6 @@
## Shell Completions Troubleshooting
### ZSH completions not working?
Make sure your ~/.zshrc contains the following:
Make sure your ~/.zshrc contains the following (if sourcing from default completions location, usually `/usr/share/zsh/functions/Completion/Unix/_mutn`):
```shell
autoload -Uz compinit && compinit
```
@@ -9,7 +9,7 @@ autoload -Uz compinit && compinit
### Bash completions not working?
Install your distribution's 'bash-completion' package or source the completion script manually.
For most environments, this would mean adding the following to your ~/.bashrc:
For most environments, manual sourcing means adding the following to your ~/.bashrc:
```shell
source /usr/share/bash-completion/completions/mutn
```
wiki/MUTN/install.md
+8
View File
@@ -0,0 +1,8 @@
## Installation
MUTN is still in early development and thus no installation packages are officially distributed.
For now, please [compile from source](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/build.md).
After compiling and placing the binaries in your $PATH, it is highly recommended to also download and correctly place/source the relevant shell completions scripts. [Shell completions are provided for ZSH, Bash, and PowerShell 7+](https://github.com/rwinkhart/MUTN/tree/main/completions).
For help with completions scrips, see [completions troubleshooting](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/completions.md).