Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 45 additions & 8 deletions developer/building.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
# Building Gershwin

Gershwin is built using [gershwin-build](https://github.com/gershwin-desktop/gershwin-build), which orchestrates building all components from source.
Gershwin is built using [gershwin-developer](https://github.com/gershwin-desktop/gershwin-developer), which orchestrates building all components from source.

## Quick start

Run these as root. `bootstrap.sh` installs the build dependencies for your OS,
`checkout.sh` clones the component repositories into `Library/Sources`, and
`make install` builds and installs the system domain.

```console
git clone https://github.com/gershwin-desktop/gershwin-build.git
cd gershwin-build
./bootstrap.sh
./checkout.sh
make install
git clone https://github.com/gershwin-desktop/gershwin-developer.git /Developer
/Developer/Library/Scripts/bootstrap.sh
/Developer/Library/Scripts/checkout.sh
cd /Developer && make install
```

To remove a build installed this way, run `cd /Developer && make uninstall`.

## Per-component builds

After building the core libraries once, individual components can be rebuilt independently:
Expand All @@ -29,7 +34,11 @@ make textedit

## Live ISOs

The various Live ISO creation scripts (FreeBSD, Debian, Arch) run `gershwin-build` as part of their build process. See `gershwin-desktop/` for the ISO definitions.
The various Live ISO creation scripts run `gershwin-developer` as part of their
build process. The ISO definitions live in the
[gershwin-desktop](https://github.com/gershwin-desktop/gershwin-desktop)
repository, one directory per base OS under `targets/`. To add a new flavor, see
its `docs/ADDING-A-FLAVOR.md`.

## Build targets

Expand All @@ -42,10 +51,38 @@ The various Live ISO creation scripts (FreeBSD, Debian, Arch) run `gershwin-buil
| `systempreferences` | System Preferences app |
| `terminal` | Terminal emulator |
| `textedit` | Text editor |
| `eau-theme` | Eau theme |

## Controlling the checkout

`checkout.sh` reads three environment variables.

`SKIP_REPOS` takes a space- or comma-separated list of repository names to leave
alone. Use it when you want to supply a repository's sources yourself — symlink
your own working copy into `Library/Sources/` and the build picks it up:

```console
SKIP_REPOS="gershwin-workspace" /Developer/Library/Scripts/checkout.sh
```

`BRANCH` checks out the named branch in every repository that has one, falling
back to the default branch elsewhere. A partial rollout therefore works without
further ceremony, which makes it useful for testing a feature branch that spans
several repositories:

```console
BRANCH=dev /Developer/Library/Scripts/checkout.sh
```

`PINNED=0` builds against the upstream HEADs instead of the pinned commits. The
upstream GNUstep libraries are pinned by default so that the patches in
`Library/Patches/` keep applying; unset the pins to check whether a pin can move
forward. Gershwin's own repositories are never pinned.

## Requirements

- Clang/LLVM toolchain
- GNUstep make (`tools-make`)
- X.org development headers
- Per-component dependencies documented in each repository
- The packages listed in `Library/OSSupport/` for your OS, which `bootstrap.sh`
installs for you
2 changes: 1 addition & 1 deletion developer/distributions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Note to distributions

The Gershwin Desktop is under active development, and things change rapidly. Hence, it is currently not recommended to attempt packaging the Gershwin Desktop in a traditional way. Instead, the use of [gershwin-build](https://github.com/gershwin-desktop/gershwin-build) is highly encouraged for the time being.
The Gershwin Desktop is under active development, and things change rapidly. Hence, it is currently not recommended to attempt packaging the Gershwin Desktop in a traditional way. Instead, the use of [gershwin-developer](https://github.com/gershwin-desktop/gershwin-developer) is highly encouraged for the time being.

Please do not hesitate to contact the team if you have questions regarding this policy.
19 changes: 13 additions & 6 deletions developer/linux.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# Linux

Gershwin can be built and run on Linux. The primary supported distributions are Debian, Devuan, Arch Linux, and Artix.
Gershwin can be built and run on Linux. The supported distributions are the ones
with a package list in `Library/OSSupport/`: Debian, Devuan, Ubuntu, Arch Linux,
Artix, Manjaro, and Void.

## Building

Use [gershwin-build](https://github.com/gershwin-desktop/gershwin-build) for building from source.

For manual development setup, clone `gershwin-developer` and run the bootstrap and checkout scripts:
Clone [gershwin-developer](https://github.com/gershwin-desktop/gershwin-developer)
and run the bootstrap and checkout scripts. These run as root:

```console
git clone https://github.com/gershwin-desktop/gershwin-developer.git /Developer
/Developer/Library/Scripts/bootstrap.sh
/Developer/Library/Scripts/checkout.sh
cd /Developer && sudo make install
cd /Developer && make install
```

See [Building Gershwin](building.md) for the per-component build targets and the
`checkout.sh` environment variables.

## Requirements

- GNUstep
Expand All @@ -25,4 +29,7 @@ cd /Developer && sudo make install

- The `initgfx` graphics autoconfiguration script is FreeBSD-specific
- D-Bus integration may behave slightly differently than on BSD
- Some system services use systemd or OpenRC depending on the distribution
- Init handling varies by distribution: systemd on Debian, Ubuntu and Arch;
sysvinit on Devuan; runit on Void and Artix. LoginWindow ships a service for
systemd, sysvinit and FreeBSD `rc.d` only, so on runit the session has to be
started from `startx` or a display manager.
12 changes: 7 additions & 5 deletions developer/rpi.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,17 @@ Using the Raspberry Pi Imager tool, flash the OS image file to a microSD card (i

The rest is done via SSH, which is preconfigured on the Devuan image.

Then follow https://github.com/gershwin-desktop/gershwin-build standard procedure:
Then follow the standard
[gershwin-developer](https://github.com/gershwin-desktop/gershwin-developer)
procedure, as root:

```
# Get the rest of the requirements for building
git clone https://github.com/gershwin-desktop/gershwin-build.git && cd gershwin-build
sudo ./bootstrap.sh
./checkout.sh
git clone https://github.com/gershwin-desktop/gershwin-developer.git /Developer
/Developer/Library/Scripts/bootstrap.sh
/Developer/Library/Scripts/checkout.sh
# Build and install Gershwin from sources
sudo make install
cd /Developer && make install
```

Finally, run `/System/Library/Scripts/SystemPrepare.sh`. It will configure the system to boot straight into Gershwin Desktop. Reboot the system when it is done.
2 changes: 1 addition & 1 deletion user/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For testing without installation, Live ISOs are available at the [Gershwin Deskt

## Installation from source

Follow the instructions at [gershwin-build](https://github.com/gershwin-desktop/gershwin-build).
Follow the instructions at [gershwin-developer](https://github.com/gershwin-desktop/gershwin-developer).

## Raspberry Pi

Expand Down