Skip to content

Commit

Permalink
docs: improve windows build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sparecycles committed Sep 14, 2024
1 parent f6cfc44 commit b7bace0
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions packages/docs/src/content/docs/intro/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ prev: false

[`http://localhost:3000`]: http://localhost:3000

import { FileTree } from '@astrojs/starlight/components';
import { FileTree, Aside } from '@astrojs/starlight/components';
import { SolidIcon, CollectionLinkCard } from '@components';

:::tip
Expand All @@ -35,14 +35,30 @@ You can use this to demo some workflows.
## Installation and Building

To get started with Pardon, first build the Pardon application.
```bash
```bash title="building pardon"
$ git clone https://github.com/adobe/pardon.git
$ cd pardon
$ npm install
$ npm install --prefix=packages/core
$ npm install --prefix=packages/favor
$ npm run package --prefix=packages/favor # also rebuilds pardon's core
$ npm run package --prefix=packages/favor # this also rebuilds pardon's core
```

<Aside type="caution" title="Building on Windows">
<details>
<summary>When building on windows, instead of using `--prefix`, please `cd` to the various subdirectories.</summary>
```bash title="powershell or cmd"
$ git clone https://github.com/adobe/pardon.git
$ cd pardon
$ npm install
$ cd packages/core
$ npm install
$ cd ../favor
$ npm install
$ npm run package
```
</details>
</Aside>

The Pardon application is built into `./packages/favor/out/...`
(path depends on your plaform, osx and windows should both work,
Expand Down

0 comments on commit b7bace0

Please sign in to comment.