Skip to content

Commit

Permalink
docs: add notes on where the application is built
Browse files Browse the repository at this point in the history
  • Loading branch information
sparecycles committed Sep 6, 2024
1 parent 15be647 commit c15cfe1
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion packages/docs/src/content/docs/intro/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ $ npm install --prefix=packages/favor
$ npm run package --prefix=packages/favor # also rebuilds pardon's core
```

The Pardon application is built into `./packages/favor/out/...`
(path depends on your plaform, osx and windows should both work,
have not tested any linux flavors yet.)

Optionally, you can link the built application as a command-line tool as well.
```bash title="optional"
$ cd packages/core
Expand Down Expand Up @@ -93,7 +97,9 @@ After running `npm start`, please open a browser to [`http://localhost:3000`] to

## Open the example workspace

It's time to run the pardon application and set the context to the `example-todo` directory.
It's time to run the pardon application (find it in `./packages/favor/out/...`) and
set the context to the `example-todo` directory (setting the context is in the file menu).

If everything went well, you should have

```
Expand Down

0 comments on commit c15cfe1

Please sign in to comment.