Adds man page and makefile, updates license, removes binary

master
sloum 1 year ago
parent fb7198def3
commit 3299a6e2f4
  1. 1
      .gitignore
  2. 3
      LICENSE
  3. 32
      Makefile
  4. BIN
      slp
  5. 48
      slp.1

1
.gitignore vendored

@ -0,0 +1 @@
slp

@ -2,6 +2,9 @@ MIT License
Copyright (c) 2017 Zac Garby
For forked/modified code:
Copyright (c) 2021 Sloum <sloum @ rawtext.club>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights

@ -0,0 +1,32 @@
GOCMD := go
BINARY := slp
PREFIX := /usr/local
EXEC_PREFIX := ${PREFIX}
BINDIR := ${EXEC_PREFIX}/bin
DATAROOTDIR := ${PREFIX}/share
MANDIR := ${DATAROOTDIR}/man
MAN1DIR := ${MANDIR}/man1
.PHONY: build
build:
${GOCMD} build -ldflags "-w -s" -o ${BINARY}
.PHONY: install
install: install-bin install-man clean
.PHONY: install-bin
install-bin: build
install -d ${DESTDIR}${BINDIR}
install -m 0755 ./${BINARY} ${DESTDIR}${BINDIR}
.PHONY: install-man
install-man: ${BINARY}.1
gzip -k ./${BINARY}.1
install -d ${DESTDIR}${MAN1DIR}
install -m 0644 ./${BINARY}.1.gz ${DESTDIR}${MAN1DIR}
.PHONY: clean
clean:
${GOCMD} clean
rm -f ./${BINARY}.1.gz 2> /dev/null
rm -f ./${BINARY}_* 2> /dev/null

BIN
slp

Binary file not shown.

48
slp.1

@ -0,0 +1,48 @@
.TH "slp" 1 "20 AUG 2021" "" "General Operation Manual"
.SH NAME
\fBslp\fP - (sl)ope (p)ackage manager
.SH SYNOPSIS
.nf
.fam C
\fBslp\fP [\fIargs\fP...]
.fam T
.fi
.SH DESCRIPTION
\fBslp\fP is a basic package management system for the slope programming language.
.SH OPTIONS
.TP
.B
\fBhelp\fP
Display usage help and exit. Provides a list of all command line options with a short description and exits.
.TP
.B
\fBlist\fP
Display a list of \fIall\fP packages in the registry
.TP
.B
\fB+<package>\fP
Installs \fI<package>\fP, if it is found
.TP
.B
\fB-<package>\fP
Removes \fI<package>\fP, if it is found
.TP
.B
\fB^<package>\fP
Updates \fI<package>\fP, if it is found
.TP
.B
\fB?<term>\fP
Searches for \fI<term>\fP in the package registry and displays matching results
.SH BUGS
There are bugs. Have fun!
.SH LINKS
\fBslp\fP maintains a presence in the following locations:
.TP
.B
Source Code Repository
https://git.rawtext.club/slope-lang/slp
.SH AUTHORS
\fBslp\fP is developed by sloum
.TP
Based on existing work by Zac Garby (see LICENSE)
Loading…
Cancel
Save