Skip to content

Commit

Permalink
Update build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lemonyte committed Oct 27, 2024
1 parent a23d73d commit cd192a0
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 128 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,26 +37,27 @@ svg = vector.encode(VectorFormat.SVG)

## Building

If you wish to build the package from source, clone the repository and follow the instructions for your platform below.

### Linux and MacOS
If you wish to build the package from source, the easiest way to do so is with [uv](https://docs.astral.sh/uv/).
Clone the repository and run the following commands inside the project directory.

```shell
sh ./scripts/build_unix.sh
```
# Clone the AutoTrace submodule.
git submodule update --init

A virtual environment will be created using your default Python installation.
Compilation requires GLib, pkg-config, and unzip to be installed on your system, which most Linux distributions include by default.
On MacOS you can install GLib with `brew install glib`.
# If you're on Windows, extract the GLib headers archive.
Expand-Archive "third-party\autotrace\distribute\win\3rdparty\glib-dev_2.34.3-1_win64.zip" -DestinationPath "third-party\glib"

### Windows
# If you're on macOS, install GLib with Homebrew.
brew install glib

```shell
.\scripts\build_windows.ps1
# Build the package with uv.
uv build
```

A virtual environment will be created using your default Python installation.
In order to compile the generated C code, you will need to have
On Linux and macOS compilation requires GLib, pkg-config, and unzip to be installed on your system, which most Linux distributions include by default.
You can install GLib on macOS with `brew install glib`.

On Windows, in order to compile the generated C code, you will need to have
[Visual C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) or another C/C++ compiler installed.

## TODO
Expand Down
51 changes: 0 additions & 51 deletions scripts/build_unix.sh

This file was deleted.

64 changes: 0 additions & 64 deletions scripts/build_windows.ps1

This file was deleted.

0 comments on commit cd192a0

Please sign in to comment.