Skip to content

Commit

Permalink
Update README.md for macOS
Browse files Browse the repository at this point in the history
  • Loading branch information
ABBAPOH committed May 3, 2024
1 parent b848802 commit 2aaae1b
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,18 @@ Before building with Hugo, do the following:

- run `yarn` in the repo root to install the node packages
- initialize submodules to check out Qbs docs (`git submodule update --init`)
- run `./_generate.sh` in the scripts subdirectory to compile qbs qdocs and process them for hugo
- make sure qmake and qdoc are in PATH
- run `./_generate.sh` from the scripts subdirectory to compile qbs qdocs and process them for hugo


## Building locally

### macOS
- First, you'd need to setup a local web server as described
[here](https://discussions.apple.com/docs/DOC-3083).
- Second, create a symlink in ~/Sites pointing to the `public/` folder in this repo, e.g.:
`ls -s ~/Sites/qbs-io ~/Developer/qbs-io/public`.
- Ensure qmake and qdoc are in PATH: `export PATH=/Applications/Qt/6.7.0/macos/bin/:$PATH`.
- Run `./_generate.sh` to rebuild docs.
- Run `hugo -b http://localhost/~${USER}/qbs-io`.
- Run `open http://localhost/~${USER}/qbs-io/`.

0 comments on commit 2aaae1b

Please sign in to comment.