hedy
/
spsrv
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README to reflect new install instructions

This commit is contained in:
hedy 2023-06-19 12:30:21 +08:00
parent 381097e8e5
commit e504383e4a
Signed by: hedy
GPG Key ID: B51B5A8D1B176372
3 changed files with 54 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -1,7 +1,7 @@
.PHONY: help build clean build-all package release
.DEFAULT_GOAL := help
pkg_root = git.sr.ht/~hedy/spsrv
pkg_root = .
### Calculate a few variables for use in building
VERSION = $(shell git describe --tags --abbrev=0 --always)
@ -17,6 +17,8 @@ ldflags = "-X 'main.appVersion=$(VERSION)' \
##@ Help
help: ## Display this help
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
@echo
@echo "Variable pkg_root is set to . by default. This should be the directory of spsrv source code."
##@ Utilities
init: ## Install utils

30
README.gmi
View File

@ -17,6 +17,7 @@ Table of Contents
=> #todo todo
Known servers running spsrv
=> spartan://hedy.tilde.cafe:3333
=> spartan://tilde.team
=> spartan://tilde.cafe
@ -26,9 +27,16 @@ Known servers running spsrv
## install
you have two options for now:
you have three options:
### Option 1: with go
### Option 1: Prebuilt binary
prebuilt binaries for darwin and linux architectures arm/amd-64 are provided since v0.5.4. Head over to the tags page on git.sr.ht, click on a desired tag and download the binary for your architecture.
=> https://git.sr.ht/~hedy/spsrv/refs
### Option 2: with go
first, you need to have go installed and have a folder ~/go with $GOPATH pointing to it.
@ -40,22 +48,30 @@ there will be a binary at ~/go/bin/ with the source code at ~/go/src/
feel free to move the binary somewhere else like /usr/sbin/
### Option 2: just build it yourself
note that it's recommended to pin any latest version `@v0.0.0` rather than the latest commit since it may not be stable.
### Option 3: just build it yourself
run git clone https://git.sr.ht/~hedy/spsrv from any directory and cd spsrv
make sure you have go installed and working.
```
git checkout v0.0.0 # optionally pin a specific tag
go build
git checkout v0.0.0 # recommended to pin a specific tag
make build
```
when it finishes, the binary will be in the current directory.
when it finishes, the binary will be in ./bin.
if you don't have make, you can just `go build` (just that version and build information will not be available with `spsrv --version`).
### otherwise...
If you don't have/want go installed, you can contact me, and if you're lucky, I have the same OS as you and you can use my compiled binary (lol). I'll eventually have automated uploads of binaries for various architectures for each release in the future.
if you do not wish to install go or clone the repo, and your architecture is not supported in the prebuilt binaries, drop an email to my public inbox (or contact me privately) so I could perhaps compile a binary for your architecture.
=> mailto:~hedy/inbox@lists.sr.ht public inbox
## configuration

41
README.md
View File

@ -22,8 +22,9 @@ Known servers running spsrv:
<!-- vim-markdown-toc GFM -->
* [install](#install)
* [Option 1: with `go install`](#option-1-with-go-install)
* [Option 2: just build it yourself](#option-2-just-build-it-yourself)
* [Option 1: prebuilt binaries](#option-1-prebuilt-binaries)
* [Option 2: with `go install`](#option-2-with-go-install)
* [Option 3: just build it yourself](#option-3-just-build-it-yourself)
* [otherwise...](#otherwise)
* [configuration](#configuration)
* [config options](#config-options)
@ -35,9 +36,17 @@ Known servers running spsrv:
## install
you have two options for now:
you have three options:
### Option 1: with `go install`
### Option 1: prebuilt binaries
prebuilt binaries for darwin and linux architectures arm/amd-64 are provided
since v0.5.4. Head over to the [tags page on
git.sr.ht](https://git.sr.ht/~hedy/spsrv/refs), click on a desired tag and
download the binary for your architecture.
### Option 2: with `go install`
first, you need to have go installed and have a folder `~/go` with `$GOPATH`
pointing to it.
@ -50,32 +59,38 @@ there will be a binary at `~/go/bin/` with the source code at `~/go/src/`
feel free to move the binary somewhere else like `/usr/sbin/`
note that it's recommended to pin any latest version `@v0.0.0` rather than the
latest commit since it may not be stable.
### Option 2: just build it yourself
### Option 3: just build it yourself
run `git clone https://git.sr.ht/~hedy/spsrv` from any directory and `cd spsrv`
make sure you have go installed and working.
```
git checkout v0.0.0 # optionally pin a specific tag
go build
git checkout v0.0.0 # recommended to pin a specific tag
make build
```
when it finishes, the binary will be in the current directory.
when it finishes, the binary will be in `./bin`.
if you don't have make, you can just `go build` (just that version and build
information will not be available with `spsrv --version`).
### otherwise...
If you don't have/want go installed, you can contact me, and if you're lucky, I
have the same OS as you and you can use my compiled binary (lol). I'll
eventually have automated uploads of binaries for various architectures for
each release in the future.
if you do not wish to install go or clone the repo, and your architecture is not
supported in the prebuilt binaries, drop an email to my [public
inbox](mailto:~hedy/inbox@lists.sr.ht) (or contact me privately) so I could
perhaps compile a binary for your architecture.
## configuration
The default config file location is `/etc/spsrv.conf` you can specify your own path by running spsrv like
The default config file location is `/etc/spsrv.conf` you can specify your own
path by running spsrv like
```
spsrv -c /path/to/file.conf