Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fan-ziqi committed Apr 27, 2024
1 parent 087ab6f commit d04f4eb
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# stl_compresser
# STL Compressor

usage:
STL Compressor is a tool designed to compress STL files efficiently. Users can conveniently compress multiple STL files in batches, reducing their file sizes without compromising on quality.

```bash
pip install -r requirements.txt
python stl_compresser_ui.py
```
## Usage

* Windows users can download [here](https://github.com/fan-ziqi/stl_compresser/releases)

* Python

```bash
git clone https://github.com/fan-ziqi/stl_compresser.git
cd stl_compresser
pip install -r requirements.txt
python stl_compresser_ui.py
```

## Packaging

To package the application as a standalone executable, use PyInstaller:

pack:
```bash
pyinstaller --onefile --windowed stl_compresser_ui.py
```

0 comments on commit d04f4eb

Please sign in to comment.