From 8611b0abe9c63195e31d5c34af155c81ed3e9227 Mon Sep 17 00:00:00 2001 From: Emily Hunt Date: Sat, 18 Jan 2025 23:46:54 +0100 Subject: [PATCH] Fix install instructions --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f2d5586..55fcded 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,11 @@ pip install sk8plotlib Turn any matplotlib line chart into a skatepark with: ```python -from sk8plotlib import sk8plotlib +import sk8plotlib.sk8plot as sk8 # ... create a matplotlib figure -sk8plotlib(fig) +sk8(fig) ``` Alternatively, you can load example maps by running SK8plotlib on the command line, such as by doing: @@ -30,3 +30,25 @@ Alternatively, you can load example maps by running SK8plotlib on the command li ```bash python -m sk8plotlib ``` + +## Roadmap + +Planned features before v0.1: + +- ~~Automatic detection of lines in plot~~ +- ~~Basic physics simulation (single accelerating point)~~ +- ~~Basic collision detection (skateboard only)~~ +- ~~Skateboard rotation on surfaces~~ +- ~~User control input~~ +- Smooth camera +- Automatic map scaling +- Auto-initialize in correct location + +Planned future features: + +- Improved player character +- ~~Improved collisions~~ (had to be done sooner than planned...) +- Improved graphics +- Music +- Support for log plots +- Scoring system? -- 2.54.0