Update docs

diff --git a/Makefile b/Makefile
index ab4d6153245bb88f29ef8f5b207ab670d47980be..dfcadb0ae4b83eedfb41d7f72a08231f190a0a41 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -25,5 +25,5 @@ create-build-folder:
        mkdir -p build
 
 format:
        mkdir -p build
 
 format:

-       prettier . --write
+       pnpx prettier . --write

        xcodebuild -project safari/Junction.xcodeproj | xcbeautify
        xcodebuild -project safari/Junction.xcodeproj | xcbeautify

diff --git a/README.md b/README.md
index 345fa6b8cbea553bf1d4083a78d2d6ffca8a4493..ccd9b12e5d04971ed97f275a6bdf509403a09b5e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,13 +26,21 @@ The project is divided into three main parts:
 
 ### Dependencies
 
 
 ### 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
 - `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.
 - `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
 
 
 ### 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
 ### 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