diff --git a/README.md b/README.md index 9819429..ff3ae04 100644 --- a/README.md +++ b/README.md @@ -11,25 +11,25 @@ It also provides a standalone tool if you want to use your library outside of Fr ## Feature Comparison -| Feature | Better Tool Library | FreeCAD internal library | -| :-- | :--: | :--: | -| Modern UI | ![X](media/check.svg) | ![-](media/no.svg) | -| Provides a shape browser | ![X](media/check.svg) | ![-](media/no.svg) | -| Tool search | ![X](media/check.svg) | ![-](media/no.svg) | +| Feature | Better Tool Library | FreeCAD internal library | +| :-- | :--: | :--: | +| Modern UI | ![X](media/check.svg) | ![-](media/no.svg) | +| Provides a shape browser | ![X](media/check.svg) | ![-](media/no.svg) | +| Tool search | ![X](media/check.svg) | ![-](media/no.svg) | | [Powerful Feeds & Speeds calculator](docs/feeds-and-speeds.md) | ![X](media/check.svg) | ![-](media/no.svg) | -| Tool dimension sketch for built-in tools | ![X](media/check.svg) | ![-](media/no.svg) | -| Can be used standalone outside of FreeCAD | ![X](media/check.svg) | ![-](media/no.svg) | -| Provides built-in common shapes | ![X](media/check.svg) | ![-](media/no.svg) | -| Store tool notes and additional info | ![X](media/check.svg) | ![-](media/no.svg) | -| Auto-generates tool icons | ![X](media/check.svg) | ![-](media/no.svg) | -| Can be used with no document open | ![X](media/check.svg) | ![-](media/no.svg) | -| [CLI tool for import/export](cli.md) | ![X](media/check.svg) | ![-](media/no.svg) | -| Read BTL files | ![X](media/check.svg) | ![X](media/check.svg) | -| Write BTL files | ![X](media/check.svg) | Deletes BTL extra data! | +| Tool dimension sketch for built-in tools | ![X](media/check.svg) | ![-](media/no.svg) | +| [Use outside of FreeCAD](docs/standalone.md) | ![X](media/check.svg) | ![-](media/no.svg) | +| Provides built-in common shapes | ![X](media/check.svg) | ![-](media/no.svg) | +| Store tool notes and additional info | ![X](media/check.svg) | ![-](media/no.svg) | +| Auto-generates tool icons | ![X](media/check.svg) | ![-](media/no.svg) | +| Can be used with no document open | ![X](media/check.svg) | ![-](media/no.svg) | +| [CLI tool for import/export](cli.md) | ![X](media/check.svg) | ![-](media/no.svg) | +| Read BTL files | ![X](media/check.svg) | ![X](media/check.svg) | +| Write BTL files | ![X](media/check.svg) | Deletes BTL extra data! | | [Import Fusion 360 tool library](docs/formats.md) | ![X](media/check.svg) | ![-](media/no.svg) | -| [Import from Camotics](docs/formats.md) | ![X](media/check.svg) | ![-](media/no.svg) | -| [Export to Camotics](docs/formats.md) | ![X](media/check.svg) | ![X](media/check.svg) | -| [Export to LinuxCNC](docs/formats.md) | ![X](media/check.svg) | ![X](media/check.svg) | +| [Import from Camotics](docs/formats.md) | ![X](media/check.svg) | ![-](media/no.svg) | +| [Export to Camotics](docs/formats.md) | ![X](media/check.svg) | ![X](media/check.svg) | +| [Export to LinuxCNC](docs/formats.md) | ![X](media/check.svg) | ![X](media/check.svg) | ## Screenshots @@ -54,33 +54,22 @@ Better Tool Library (BTL) is compatible with FreeCAD 0.19 and 0.21. - Click it - Click *Install* -To run it, just **open the Path workbench** and there should be a new icon at the end of the -toolbar: +To run it, just **open the Path workbench** and there should be a new icon at the +end of the toolbar: ![Toolbar](media/toolbar.png) ### Installation in standalone mode -To use via standalone, you will have to install BTL via setuptools. +To use BTL via standalone (=outside of FreeCAD), you will have to install it using +setuptools. ``` pip install btl ``` -Alternative installation for the development version: - -``` -git clone https://github.com/knipknap/better-tool-library.git -``` - -To run the UI in standalone mode, you need to point `qbtl` to your FreeCAD directories: - -``` -export PYTHONPATH=/usr/share/freecad/Ext/:/usr/lib/freecad/lib/ -qbtl path/to/your/toollibrary/ -``` - +Instructions for running BTL that way are [here](docs/standalone.md). ## Instructions @@ -88,6 +77,7 @@ Some instructions can be found here: - [Feeds & Speeds calculator](docs/feeds-and-speeds.md). - [Import/export function](docs/formats.md). +- [Running BTL outside of FreeCAD](docs/standalone.md). - [CLI tool](docs/cli.md). diff --git a/docs/standalone.py b/docs/standalone.py new file mode 100644 index 0000000..9e24433 --- /dev/null +++ b/docs/standalone.py @@ -0,0 +1,21 @@ +# Running BTL in Standalone Mode + +BTL can be started without opening FreeCAD, but you still need to have +FreeCAD installed. + +To run the UI in standalone mode, you also need to tell BTL where your +FreeCAD directories are by pointing `qbtl` to it. + +In Linux, this looks like that: + +``` +export PYTHONPATH=/usr/share/freecad/Ext/:/usr/lib/freecad/lib/ +qbtl path/to/your/toollibrary/ +``` + +Of course you will have to adapt the path according to your system +environment. + +Note that in standalone mode there are some minor limitations, e.g. +BTL cannot generate any new tool icons. But everything else should +work fine.