Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make development section in README.md more explicit #122

Merged
merged 2 commits into from
May 17, 2024
Merged
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
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,31 @@
[Install](https://deno.land/[email protected]/getting_started/installation) deno
which is the JS runtime to generate all webpage docs.

You need a GitHub API token with repository read access to circumvent API rate
limiting. Store it in the `GITHUB_TOKEN` environment variable for the deno
process to pick up. Run `deno task serve` in this repository root.
Then locally serve the documentation from the root of this repository. Be
patient, it may take a while on the first run.

```
$ deno task serve
```

When the documentation preview is ready and gets served, you will be greeted
with something like:

```
🍾 Site built into ./target
129 files generated in 62.64 seconds

Server started at:
http://localhost:3000/ (local)
http://192.0.2.3:3000/ (network)
```

When doing heavy development, you might end in the need to provide a GitHub API
sirhcel marked this conversation as resolved.
Show resolved Hide resolved
Token (for fetching the probe-rs repository in the background). See
[here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
for how to get yours, save it to a file like `~/.probe-rs-github-token` and
provide it to deno via the environment variable `GITHUB_TOKEN` as follows:

```
$ export GITHUB_TOKEN=$(cat ~/.probe-rs-github-token)
```