Skip to content

Commit 127d104

Browse files
author
Vladimir Vilimaitis
committed
Simplified README
1 parent 4624875 commit 127d104

1 file changed

Lines changed: 2 additions & 33 deletions

File tree

README.rst

Lines changed: 2 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,7 @@ GUI for rembg
88

99
A simple PyQt6 GUI for rembg_, a tool to remove image backgrounds.
1010

11-
Python script
12-
-------------
13-
14-
``gui.py`` is the user-facing Python version. It carries its own PEP 723
15-
script metadata, so tools such as uv can create an environment from the script
16-
itself:
11+
You can run the Python script directly with uv:
1712

1813
.. code-block:: powershell
1914
@@ -23,33 +18,7 @@ The inline dependencies use ``rembg[cpu]``. That is the portable default. If
2318
you want CUDA, create your own environment with ``rembg[gpu]`` after your
2419
ONNX Runtime GPU stack is working.
2520

26-
C++ build
27-
---------
28-
29-
The C++/QtWidgets port lives in ``src_cpp/``. It keeps the same two-pane Qt
30-
interface while using ONNX Runtime directly for the U2Net background-removal
31-
step.
32-
33-
Build it with CMake and vcpkg. vcpkg provides Qt; CMake downloads the official
34-
ONNX Runtime binary during configure unless ``ONNXRUNTIME_ROOT`` points at an
35-
already extracted release.
36-
37-
.. code-block:: powershell
38-
39-
cmake -S src_cpp -B src_cpp/build -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=C:\path\to\vcpkg\scripts\buildsystems\vcpkg.cmake
40-
cmake --build src_cpp/build --config Release
41-
ctest --test-dir src_cpp/build --output-on-failure
42-
cmake --install src_cpp/build --config Release --prefix "$PWD\dist\rembg-gui"
43-
44-
The C++ app downloads ``u2net.onnx`` on first use and caches it locally.
45-
Set ``U2NET_HOME`` to choose a different model directory.
46-
47-
Releases
48-
--------
49-
50-
Binary releases publish a Windows x64 zip bundle and a Linux x64 AppImage.
51-
The model file is not bundled; the app downloads and verifies it on first use.
52-
macOS is not part of the release workflow for now.
21+
In addition to the Python script, there is a C++/QtWidgets port in ``src_cpp/``. You can download the binary releases from the releases page.
5322

5423
Credits
5524
-------

0 commit comments

Comments
 (0)