Commit 2b0ed644 authored by PoroCYon's avatar PoroCYon
Browse files

more README tweaks

parent 0a4e7d9d
......@@ -5,7 +5,7 @@ updating the upstream version of a program. It does ***NOT*** try to be a
full-fledged package manager for systemwide use.
I made this because I thought `ls | xargs "!f() { pushd $1 && git pull && make && make install && popd }; f"`
is slightly too hacky. `sspt` is a nicer way for doing this.
is only slightly too hacky. `sspt` is a slightly nicer way for doing this.
## Dependencies
......@@ -28,6 +28,8 @@ is slightly too hacky. `sspt` is a nicer way for doing this.
./sspt-bootstrap
```
**NOTE: this currently does not work, as `install` isn't implemented yet.**
## Usage
See also `sspt -h`, `sspt -L` and `ssspt <subcommand> -h`.
......@@ -49,7 +51,7 @@ The location of the config file can be specified using the `-c` flag.
The default config can be generated by executing `sspt --mk-default-config`.
*NOTE: This will overwrite the current configuration file!*
*NOTE: This command will overwrite the current configuration file!*
### Pulling source code
......@@ -84,7 +86,8 @@ The following functions *must* be defined in the `.sspt` file:
* `sspt_clean`: Perform a cleanup.
* `sspt_clean_config`: Same as above, but also clean all configuration files.
See `sspt-autogen` for 'examples'.
See `sspt-autogen` for 'examples'. Also, don't look at `sspt-autogen`
if you still want to sleep.
### Compiling a package
......@@ -98,7 +101,8 @@ NOTE: currently, it doesn't automatically configure the package.
### Installing a package
This currently requires the package to be pulled.
This currently requires the package to be pulled (And probably built
as well, when this is implemented).
```
sspt install sspt
......@@ -106,6 +110,14 @@ sspt install sspt
**NOTE: This is not yet implemented.**
You can use `sspt pkgcmd install sspt` to directly install the package,
but this doesn't take care of:
* Checking whether the pakcage is configured, built, etc.
* Keeping a list of files that were installed in order to make uninstalling
possible
* More stuff I currently can't think of
### Updating all packages
This will pull the latest changes *and* recompile and install all packages
......@@ -123,6 +135,9 @@ sspt update sspt another-package
### Uninstalling a package
This deletes all files installed by the package. This does not, however,
delete the source tree. Use `purge` for that.
```
sspt uninstall sspt
```
......@@ -140,6 +155,15 @@ sspt purge sspt
Use `./testrun.sh` to run sspt in the test environment,
and `./testenv.sh` to execute other commands in it.
I'm open to making it more portable (by using less linuxisms and bashisms).
I'm ***NOT*** open to making it into a proper package manager à la
`pacman` or `xbps`, let alone `nix` or `guix`.
I'm ***NOT*** open to rewriting it in `<insert language here>` because
shell scritps are slow/ugly/not even a real language/... sspt isn't meant
to be professional.
## License
SAL. See `LICENSE`.
......
......@@ -10,4 +10,7 @@
* pull -> no autogen
* pull -> always edit
* install -> clean?
* .sspt file for sspt
* modularize sspt-autogen, sspt-pull for easier addition of other vcs
& build system types
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment