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.

Sign up for GitHub

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

Jump to bottom

identify a suitable version of node in the readme #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

identify a suitable version of node in the readme #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 10 additions & 3 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ The project is similar to [typeface.js](http://typeface.neocracy.org/) and [cufo

The default size is 12 pt, but exporting with a higher font size will give you better resolution when rendering the path at large sizes. It's best to match the exported size to the final rendered size, as it will produce better rounding when scaled down.

Please note to use this package, you'll need to load an older version of Node, e.g. with [nvm](https://github.com/creationix/nvm):

```
nvm install 0.10.48
nvm use 0.10.48
```

# roadmap

This project is a heavy WIP. Some things I want to explore:
Expand All @@ -35,20 +42,20 @@ New modules will be added to [text-modules](https://github.com/mattdesl/text-mod

# demos

- [Triangulated text effect](http://mattdesl.github.io/fontpath-renderer/demo/tris.html) - a custom renderer using triangles
- [Triangulated text effect](http://mattdesl.github.io/fontpath-renderer/demo/tris.html) - a custom renderer using triangles
- [Custom steiner points](http://mattdesl.github.io/shape2d-triangulate/demo/glyph.html) - finer control over triangulation for creative effects
- [WebGL Path Rendering](http://mattdesl.github.io/fontpath-gl/demo/)
- [WebGL Triangulated Rendering](http://mattdesl.github.io/fontpath-gl/demo/wireframe.html)
- [Bitmap Fonts](http://mattdesl.github.io/gl-sprite-text/demo/demo.html)
- [Signed-Distance Field Bitmap Fonts](http://mattdesl.github.io/gl-sprite-text/demo/demo-sdf.html)
- [Signed-Distance Field Bitmap Fonts](http://mattdesl.github.io/gl-sprite-text/demo/demo-sdf.html)

# modules

*Note:* New modules will be more generic and not specifically tied to "fontpath." See [text-modules](https://github.com/mattdesl/text-modules).

The framework is split into many small modules. Some of them aren't specific to fontpath, but are useful alongside it. You generally won't need to use all of them together; but instead, you'll pick and choose based on your particular application.

Most commonly, you might want to use a "renderer" which gives you a basic word-wrapper and glyph layout tools.
Most commonly, you might want to use a "renderer" which gives you a basic word-wrapper and glyph layout tools.

- [fontpath-canvas](https://github.com/mattdesl/fontpath-canvas) - a renderer using 2D Canvas and paths for fill/stroke
- [fontpath-gl](https://github.com/mattdesl/fontpath-gl) - a WebGL renderer using stackgl modules
Expand Down