Skip to content

Commit

Permalink
More getting started instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jifalops committed Nov 19, 2024
1 parent 4e287e5 commit de5e120
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,15 @@ A starting point for static websites, SPAs, and PWAs using Svelte 5 with adapter
## Getting Started

1. Clone this repository / use this template.
2. In your repository settings for GitHub Pages, choose `Deploy from a branch`.
1. In your repository settings for GitHub Pages, choose `Deploy from a branch`.
![GitHub Pages settings](https://github.com/rossjrw/pr-preview-action/raw/main/.github/deployment-settings.png)
> You may have to create the `gh-pages` branch first or let the `.github/workflows/deploy.yml` workflow do it for you.
3. Install the [Dev Containers][3] extension for VS Code to develop within the configured environment.
1. Install the [Dev Containers][3] extension for VS Code to develop within the configured environment.
1. For seamless integration:
1. Set the `TZ` and `GITHUB_TOKEN` environment variables on the host ([example][4]).
1. Have a `dotfiles` repo with an `install.sh` script that sets up your environment. See [jifalops/dotfiles][2] for an clonable example.

[1]: https://github.com/devcontainers/images/tree/main/src/typescript-node
[2]: https://github.com/jifalops/dotfiles
[3]: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
[4]: https://github.com/jifalops/dotfiles/blob/bf9627445abf5ffe25515e8a6d2fe1d1c681e606/.sh_common#L87

0 comments on commit de5e120

Please sign in to comment.