aboutsummaryrefslogtreecommitdiffsponsor
diff options
context:
space:
mode:
authorSlack Coder <slackcoder@server.ky>2022-03-31 14:24:53 -0500
committerSlack Coder <slackcoder@server.ky>2022-03-31 14:31:57 -0500
commit7d19508c417a854f357609c07e550fca0a09c8eb (patch)
tree9dbf62373e228a70bde3119d7d76084c6e135119
parent29589a24b13fb223b113e94eca2c4fff0e56a4d9 (diff)
downloadpkgtools-go-7d19508c417a854f357609c07e550fca0a09c8eb.tar.xz
README: improve formatting content
-rw-r--r--README.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/README.md b/README.md
index 75b2701..e648e3a 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
# Slackware Package Tools Alternative
-Replacement for Slackware's core package management tools.
+An alternative set of Slackware's core package management tools.
-You can help improve this project through [funding](https://funding.server.ky/project/pkgtools-go).
+Planned improvements and known issues are listed on the project's [issue tracker](https://todo.sr.ht/~slack-coder/pkgtools-go). You can help improve this project through [funding](https://funding.server.ky/project/pkgtools-go).
## Benefits
@@ -28,21 +28,26 @@ The recommended way to build these tools is to call this command from within
the directory. The additional parameters are recommended to minimize external
dependencies.
+You likely want to set the GOBIN environment variable to your preferred install
+location.
+
```
- go build -ldflags="-linkmode external -extldflags -static" ./cmd/installpkg
+ go install \
+ -ldflags="-linkmode external -extldflags -static" \
+ -a ./cmd/...
```
## Whats included?
+The commands 'installpkg' and 'removepkg' are included.
+
These tools are planned to be included:
- - installpkg
- - removepkg
+ - explodepkg
- upgradepkg
These tools will likely not be included:
- - explodepkg
- makepkg
- pkgdiff
- pkgtool