diff options
| author | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2023-09-14 11:14:53 +0200 |
|---|---|---|
| committer | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2023-09-14 11:14:53 +0200 |
| commit | 5d2c4ecb44233569a516dde301a02d44098ec15d (patch) | |
| tree | c74eef963d695d0fd9f45c95247a83fdbe5b9bd5 | |
| parent | 30295bf26ceb753bda98b0808c98021dc2b5901b (diff) | |
Update docs
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | README.md | 22 |
2 files changed, 18 insertions, 6 deletions
@@ -25,5 +25,5 @@ create-build-folder: mkdir -p build format: - prettier . --write + pnpx prettier . --write xcodebuild -project safari/Junction.xcodeproj | xcbeautify @@ -26,13 +26,21 @@ The project is divided into three main parts: ### Dependencies -- `make` to run the build commands. -- `xcode` to build the safari extension. +- `make` to run the build commands. It's included in `macos` +- `xcode` to build the safari extension. Can be downloaded from the + [apple developer portal][xcode-download]. - `node` and `pnpm` to build the extension, and if you want to run the server - directly. + directly. Node can be installed via brew with `brew install node`, or with + a version manager like [asdf][asdf]. For `pnpm` check the [website][pnpm]. - `podman` and `podman-compose` if you want to run the server as a container. -- `prettier` to format Javascript, JSON, Yaml, and Markdown. -- `xcbeautify` to format swift + Both can be installed with homebrew `brew install podman podman-compose` +- `prettier` to format Javascript, JSON, Yaml, and Markdown. Will automatically + install when running `make format`. +- `xcbeautify` to format swift. Can be installed with homebrew + `brew install xcbeautify` + +If you're running macos and using homebrew, you can install them all with +`make prepare-environment`. ### Server @@ -83,3 +91,7 @@ Open `Junction.app` and then enable the extension in Safari. ### Formatting Running `make format` will format the code with prettify and xcbeautify + +[xcode-download]: https://developer.apple.com/xcode/resources/ +[asdf]: https://asdf-vm.com/ +[pnpm]: https://pnpm.io/installation |