Skip to content
Merged
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
59 changes: 59 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Builds the website (site/) and publishes it to GitHub Pages: https://tuna-nope.github.io/macbox/
# Pull requests only build and check it; pushes to main deploy it, then tell IndexNow (Bing and
# others) which pages exist. Google reads the sitemap through Search Console.
name: Website

on:
push:
branches: [main]
paths: ["site/**", "docs/images/**", "llms.txt", "macbox", "sims/bin/mac-sim", ".github/workflows/pages.yml"]
pull_request:
paths: ["site/**", "docs/images/**", "llms.txt", "macbox", "sims/bin/mac-sim", ".github/workflows/pages.yml"]
workflow_dispatch:

permissions:
contents: read

concurrency:
group: pages-${{ github.ref }}
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/setup-python@v7
with:
python-version: "3.13"
- name: Build and check
run: python3 site/build.py
- uses: actions/upload-pages-artifact@v5
if: github.event_name != 'pull_request'
with:
path: site/_site

deploy:
if: github.event_name != 'pull_request'
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
- name: Submit the sitemap's URLs to IndexNow
continue-on-error: true
env:
SITE: https://tuna-nope.github.io/macbox
KEY: d0f80829b645869eb473963b6ad2dd95
run: |
sleep 30 # let the new deployment reach the CDN
urls=$(curl -fsS "$SITE/sitemap.xml" | grep -o '<loc>[^<]*' | sed 's/<loc>//' | python3 -c 'import json,sys; print(json.dumps(sys.stdin.read().split()))')
body=$(printf '{"host":"tuna-nope.github.io","key":"%s","keyLocation":"%s/%s.txt","urlList":%s}' "$KEY" "$SITE" "$KEY" "$urls")
curl -sS -o /dev/null -w 'IndexNow: HTTP %{http_code}\n' -X POST https://api.indexnow.org/indexnow \
-H 'Content-Type: application/json; charset=utf-8' -d "$body"
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ your Vulkan GPU), with Xcode, a pool of iOS Simulators, T3 Code's Device panel,
coding agents (Claude Code, Codex, T3 Code) need to build, run, drive and check iOS apps on their
own. One command, `macbox`, sets it up and runs it.

**Website and guides:** [tuna-nope.github.io/macbox](https://tuna-nope.github.io/macbox/): macOS, Xcode and
the iOS Simulator on Linux, Expo apps, the GPU path, and AI coding agents with T3 Code.

![The macOS desktop in macbox, with two iOS 26.5 Simulators: a Liquid Glass benchmark at 1x and Safari](docs/images/hero.jpg)

<sub>macOS 26 Tahoe's desktop in macbox on an Intel iGPU, with two of its iOS 26.5 Simulators in front
Expand Down Expand Up @@ -159,6 +162,7 @@ silicon only. It also can't run macOS legally on non-Apple hardware (see below).
| [docs/troubleshooting.md](docs/troubleshooting.md) | when something doesn't work |
| [guest/README.md](guest/README.md) | what runs inside macOS |
| [patches/README.md](patches/README.md) | the patch series on Reims vGPU and metal2vulkan |
| [site/](site/README.md) | the website's source: the guides at https://tuna-nope.github.io/macbox/guides/ |

## Credits

Expand Down
13 changes: 13 additions & 0 deletions llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,16 @@ Requirements: an x86-64 Linux host with KVM, AVX2, an Intel or AMD GPU with a Me
- [Patches](https://github.com/TUNA-NOPE/macbox/blob/main/patches/README.md)
- [Troubleshooting](https://github.com/TUNA-NOPE/macbox/blob/main/docs/troubleshooting.md)
- [Credits](https://github.com/TUNA-NOPE/macbox/blob/main/CREDITS.md)

## Website

The same project as a website, with task guides. Each page has a Markdown copy at `index.md` in the same folder.

- [Overview](https://tuna-nope.github.io/macbox/index.md): what macbox is, features, measured performance, comparison, requirements, quick start
- [How to run macOS on Linux with GPU acceleration](https://tuna-nope.github.io/macbox/guides/run-macos-on-linux/index.md)
- [How to run Xcode on Linux](https://tuna-nope.github.io/macbox/guides/xcode-on-linux/index.md)
- [iOS Simulator on Linux](https://tuna-nope.github.io/macbox/guides/ios-simulator-on-linux/index.md)
- [Expo and React Native iOS apps on Linux](https://tuna-nope.github.io/macbox/guides/expo-react-native-ios-on-linux/index.md)
- [iOS Simulators for AI coding agents: Claude Code, Codex, T3 Code](https://tuna-nope.github.io/macbox/guides/ios-simulator-for-ai-coding-agents/index.md)
- [GPU-accelerated macOS VM on Linux, without passthrough](https://tuna-nope.github.io/macbox/guides/gpu-accelerated-macos-vm-on-linux/index.md)
- [macbox vs Docker-OSX and OSX-KVM](https://tuna-nope.github.io/macbox/guides/macbox-vs-docker-osx-and-osx-kvm/index.md)
1 change: 1 addition & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_site/
32 changes: 32 additions & 0 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# The website

The source of https://tuna-nope.github.io/macbox/, built by `build.py` (Python's standard library,
nothing to install) and published to GitHub Pages by `.github/workflows/pages.yml` on every push
to main that touches it.

```sh
python3 site/build.py # build into site/_site and check it
python3 site/build.py --serve # the same, then http://127.0.0.1:8000/macbox/
```

| | |
|---|---|
| `pages/` | one HTML fragment per page. A header of `key: value` lines, then `---`. The file's path is the URL: `pages/guides/xcode-on-linux.html` is `/guides/xcode-on-linux/` |
| `layout.html`, `style.css` | the frame around every page; the CSS is inlined |
| `static/` | copied as is: the favicon, the IndexNow key, search engines' verification files, and the home page's pictures in `static/images/`: `desk-*` is a real, uncropped capture of the macOS VM's whole screen (1600x1200: Simulator.app running Nimbus, a demo weather app made for these pictures, next to its website in Safari), saved as `-quality 84 desk-1600.webp`, `-resize 800x -quality 82 desk-800.webp` and `-quality 84 -interlace JPEG desk-1600.jpg`; `phone-today.webp` and `phone-cities.webp` are Nimbus's two screens from `mac-sim shot` on the 3x `sharp` simulator, `-resize 600x -quality 86`. The logos on the home page are inline SVG: Claude's from Simple Icons, OpenAI's and T3 Code's from T3 Code's repository) |

The repo stays the source of truth. The guides answer one question each and link to `docs/` for the
full reference; pictures (`docs/images`) and `llms.txt` are copied from the repo at build time, not
kept twice. When a command or a number changes in the docs, change it in the guides that show it.

**Adding a guide:** a new file in `pages/guides/` with `title`, `short` (the breadcrumb),
`description` (50 to 165 characters, unique), `kind: guide`, `order` and `updated: YYYY-MM-DD`.
The guide lists, the sitemap and the structured data pick it up. Add it to `llms.txt` too.

**The build fails on:** a broken internal link or `#anchor`, a missing or duplicate title or
description, a page without exactly one `<h1>`, and a `macbox <command>` or `mac-sim <command>` in
a code sample that the CLI doesn't have.

Every page also gets a Markdown copy (`index.md` beside `index.html`) for language models, as
llmstxt.org suggests. robots.txt can't be set here: crawlers read it only at the host's root
(`tuna-nope.github.io/robots.txt`), which this repo doesn't control. Pages carry robots meta tags.
Loading
Loading