PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Improve example READMEs (#1045)

Browse source 
* Update core-example README

* Update core-example README

* Update core-example-advanced README

* Update tldraw-example README

* Fix typo

* Fix typo
This commit is contained in:
Tobias Løfgren 2022-12-03 14:11:19 +01:00 committed by GitHub
parent b147fd30d1
commit da0d617f0c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
examples/core-example-advanced/README.md
View file

@ -8,6 +8,11 @@ An advanced example project for `@tldraw/core`.
To start this project: To start this project:
- run `yarn start:core` from the repository's root directory 1. Run `yarn` from the repository's root directory
- open `localhost://5421` in your browser 2. Run `yarn start:core` from the repository's root directory
- OR run `yarn dev` from the `examples/core-example-advanced` directory 3. Open http://localhost:5421/ in your browser
As an alternative to running `yarn start:core` you can also:
1. Run `yarn build` from the repository's root directory
2. Run `yarn dev` from the `examples/core-example-advanced` directory

7
examples/core-example/README.md
View file

@ -8,6 +8,7 @@ An simple example project for `@tldraw/core`.
To start this project: To start this project:
- run `yarn` from the repository's root directory 1. Run `yarn` from the repository's root directory
- run `yarn dev` from the `examples/core-example` directory 2. Run `yarn build` from the repository's root directory
- open `localhost://5422` in your browser 3. Run `yarn dev` from the `examples/core-example` directory
4. Open http://localhost:5422/ in your browser

11
examples/tldraw-example/README.md
View file

@ -8,6 +8,11 @@ An simple example project for `@tldraw/tldraw`.
To start this project: To start this project:
- run `yarn` from the repository's root directory 1. Run `yarn` from the repository's root directory
- run `yarn start` from the repository's root directory 2. Run `yarn start` from the repository's root directory
- OR run `yarn dev` from the `examples/tldraw-example` directory 3. Open http://localhost:5420/ in your browser
As an alternative to running `yarn start` you can also:
1. Run `yarn build` from the repository's root directory
2. Run `yarn dev` from the `examples/tldraw-example` directory