Skip to content

Commit

Permalink
Add --help output to README, fix superslicer reference
Browse files Browse the repository at this point in the history
  • Loading branch information
bofh69 committed Mar 6, 2024
1 parent 264669a commit 44b538f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 7 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
# Spoolman to slicer filament transfer
Create [SuperSlicer](https://github.com/supermerill/SuperSlicer) filament configuration from the filaments in [Spoolman](https://github.com/Donkie/Spoolman).

## Usage

```sh
usage: spoolman2slicer.py [-h] [--version] -d DIR
[-s {orcaslicer,prusaslicer,sl1cer,superslicer}]
[-u URL] [-U] [-D]

Fetches filaments from Spoolman and creates slicer filament config files.

options:
-h, --help show this help message and exit
--version show program's version number and exit
-d DIR, --dir DIR the filament config dir
-s {orcaslicer,prusaslicer,sl1cer,superslicer}, --slicer {orcaslicer,prusaslicer,sl1cer,superslicer}
the slicer
-u URL, --url URL URL for the Spoolman installation
-U, --updates keep running and update filament configs if they're
updated in Spoolman
-D, --delete-all delete all filament configs before adding existing
ones
```

## Prepare for running

Run:
Expand All @@ -19,11 +41,7 @@ it creates. They are stored with the filaments' material's name in
## Run

```sh
./spoolman2slicer.py -d ~/.config/SuperSlicer/filament/
./spoolman2slicer.py -U -d ~/.config/SuperSlicer/filament/
```

If `-D` is given, all ini files are removed in the directory before
the new ones are created.

`-U` will cause the program to keep running, adding, updating and
deleting files when the filaments are changed in Spoolman.
See the other options above.
2 changes: 1 addition & 1 deletion spoolman2slicer.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
SUPERSLICER = "superslicer"

parser = argparse.ArgumentParser(
description="Fetches filaments from Spoolman and creates SuperSlicer filament configs.",
description="Fetches filaments from Spoolman and creates slicer filament config files.",
)

parser.add_argument("--version", action="version", version="%(prog)s 0.0.1")
Expand Down

0 comments on commit 44b538f

Please sign in to comment.