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.

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

add ROADMAP.md #23

Merged
merged 1 commit into from
Nov 20, 2020
Merged
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Roadmap

1. Split sdf into multiple packages:
- core: SDF primitives (ie- things with real eval functions)
- shapes: useful higher-level shapes made from primitives
- render: functions that render SDFs to verious output formats

2. Cleanup the the public API -- the core package should be clean with a stable API:
- Make private things that aren't needed externally.
- Make public things that might be needed by external shape
libraries or renderers.

3. Clean up error handling:
- Get rid of panics. They should really be error returns from the
functions.
- Return errors in those places where we currently might only be
printing them.