[chore] Assorted small improvements to docs (#928)
* Remove leftover references to removed Electron app (Experimental Electron app was purged in #893) * Correct thanking organization in CONTRIBUTING.md * Remove reference to pressure (ease) in Vec.pointsBetween description Used to have an "ease" param, removed in #163 * Make links to core examples from core/README.md more explicit
This commit is contained in:
Wes Lord
GitHub
parent
2c8e202c1f
commit
2ebeb01b8a
5 changed files with 6 additions and 7 deletions
|
|
@ -75,6 +75,6 @@ When you're finished with the changes, create a pull request, also known as a PR
|
|||
|
||||
### Your PR is merged!
|
||||
|
||||
Congratulations :tada::tada: The GitHub team thanks you :sparkles:.
|
||||
Congratulations :tada::tada: The tldraw team thanks you :sparkles:.
|
||||
|
||||
Once your PR is merged, your contributions will become part of the next tldraw release, and will be visible in the [tldraw app](https://tldraw.com).
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ This repository is a monorepo containing two packages:
|
|||
- [**packages/tldraw**](https://github.com/tldraw/tldraw/tree/main/packages/tldraw) contains the source for the [@tldraw/tldraw](https://www.npmjs.com/package/@tldraw/tldraw) package. This is an editor as a React component named `<Tldraw>`. You can use this package to embed the tldraw editor in any React application.
|
||||
- [**packages/core**](https://github.com/tldraw/tldraw/tree/main/packages/core) contains the source for the [@tldraw/core](https://www.npmjs.com/package/@tldraw/core) package. This is a renderer for React components in a canvas-style UI. It is used by `@tldraw/tldraw` as well as several other projects.
|
||||
|
||||
...and three apps:
|
||||
...and two apps:
|
||||
|
||||
- [**apps/www**](https://github.com/tldraw/tldraw/tree/main/apps/www) contains the source for the [tldraw.com](https://tldraw.com) website.
|
||||
- [**apps/vscode**](https://github.com/tldraw/tldraw/tree/main/apps/vscode) contains the source for the [tldraw VS Code extension](https://marketplace.visualstudio.com/items?itemName=tldraw-org.tldraw-vscode).
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@ npm i @tldraw/core
|
|||
|
||||
There are two examples in this repository.
|
||||
|
||||
The **simple** example in the `example` folder shows a minimal use of the library. It does not do much but this should be a good reference for the API without too much else built on top.
|
||||
The **simple** example in [`examples/core-example`](https://github.com/tldraw/tldraw/tree/main/examples/core-example) shows a minimal use of the library. It does not do much but this should be a good reference for the API without too much else built on top.
|
||||
|
||||
The **advanced** example in the `example-advanced` folder shows a more realistic use of the library. (Try it [here](https://core-steveruiz.vercel.app/)). While the fundamental patterns are the same, this example contains features such as: panning, pinching, and zooming the camera; creating, cloning, resizing, and deleting shapes; keyboard shortcuts, brush-selection; shape-snapping; undo, redo; and more. Much of the code in the advanced example comes from the [@tldraw/tldraw](https://tldraw.com) codebase.
|
||||
The **advanced** example in [`examples/core-example-advanced`](https://github.com/tldraw/tldraw/tree/main/examples/core-example-advanced) shows a more realistic use of the library. (Try it [here](https://core-steveruiz.vercel.app/)). While the fundamental patterns are the same, this example contains features such as: panning, pinching, and zooming the camera; creating, cloning, resizing, and deleting shapes; keyboard shortcuts, brush-selection; shape-snapping; undo, redo; and more. Much of the code in the advanced example comes from the [@tldraw/tldraw](https://tldraw.com) codebase.
|
||||
|
||||
If you're working on an app that uses this library, I recommend referring back to the advanced example for tips on how you might implement these features for your own project.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,11 +17,10 @@ This repository is a monorepo containing two packages:
|
|||
- [**packages/tldraw**](https://github.com/tldraw/tldraw/tree/main/packages/tldraw) contains the source for the [@tldraw/tldraw](https://www.npmjs.com/package/@tldraw/tldraw) package. This is an editor as a React component named `<Tldraw>`. You can use this package to embed the tldraw editor in any React application.
|
||||
- [**packages/core**](https://github.com/tldraw/tldraw/tree/main/packages/core) contains the source for the [@tldraw/core](https://www.npmjs.com/package/@tldraw/core) package. This is a renderer for React components in a canvas-style UI. It is used by `@tldraw/tldraw` as well as several other projects.
|
||||
|
||||
...and three apps:
|
||||
...and two apps:
|
||||
|
||||
- [**apps/www**](https://github.com/tldraw/tldraw/tree/main/apps/www) contains the source for the [tldraw.com](https://tldraw.com) website.
|
||||
- [**apps/vscode**](https://github.com/tldraw/tldraw/tree/main/apps/vscode) contains the source for the [tldraw VS Code extension](https://marketplace.visualstudio.com/items?itemName=tldraw-org.tldraw-vscode).
|
||||
- [**apps/electron**](https://github.com/tldraw/tldraw/tree/main/apps/electron) contains the source for an experimental Electron app.
|
||||
|
||||
...and three examples:
|
||||
|
||||
|
|
|
|||
|
|
@ -517,7 +517,7 @@ export class Vec {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get an array of points (with simulated pressure) between two points.
|
||||
* Get an array of points between two points.
|
||||
* @param A The first point.
|
||||
* @param B The second point.
|
||||
* @param steps The number of points to return.
|
||||
|
|
|
|||
Loading…
Reference in a new issue