Focus readme on people trying out the SDK with their own Python code.#97
Conversation
De-emphasize the SDK-demoing-itself use case. * Remove redundancy between readme and CONTRIBUTING.md. Merge the build-tool-specific instructions from readme into CONTRIBUTING.md. * Add a warning about deferred imports. * Improve concision. * Shorten an unnecessarily long import people shouldn't copy. * Make clear we may break backward-compat while in beta. * Remove now-unnecessary submodule and manual `uv sync` instructions from CONTRIBUTING. Also, `make help` doesn't verify anything. Perhaps it once did.
| make DEV_MODE=0 # Uses `uv run fastly-compute-py` instead of `cargo run` | ||
| make serve # Serve default example (Bottle) | ||
| make serve EXAMPLE=flask-app # Serve Flask example | ||
| make serve EXAMPLE=game-of-life # Serve Conway's Game of Life example |
There was a problem hiding this comment.
Once possible, I think removing references to use of the Makefile is probably best avoided. I think it might be better to references/link the examples or, if we keep this, ensure we first point people to CONTRIBUTING.md for installation of dependencies, etc.
There was a problem hiding this comment.
Sorry, I'm confused. Are you suggesting to move all this example-related stuff to examples/README.md and link to that? If so, sgtm. example/README.md was my next target. (I thought the main readme + CONTRIBUTING was a big enough bite for one PR.)
There was a problem hiding this comment.
Good point on the lack of prereqs (Rust, etc.) in this version.
There was a problem hiding this comment.
I believe it's all taken care of in d9d6296. I moved the instructions on how to run examples to examples/README.md and pointed to the Prereqs section in CONTRIBUTING from there. Also deleted some no-longer-true cruft from the examples readme.
I believe above you're suggesting we try to get rid of customer-facing references to make, correct? If so, I'm inclined to agree. How to expose examples will require a bit of thought, though.
There was a problem hiding this comment.
I believe above you're suggesting we try to get rid of customer-facing references to make, correct? If so, I'm inclined to agree. How to expose examples will require a bit of thought, though.
Yeah, that's the basic thought. I think the updates makes sense and I'll approve. We can do another pass once we have wheels on pypi/etc. and figure out a better way of providing the examples. I just want to avoid having most visitors be immediately exposed to needing to mess with the Makefile and dependency chain when getting started.
* Merge talk of examples from root-level readme into examples-dir readme. * Link to where to get wasm-tools and Viceroy. Running examples is still woefully heavyweight, and we should do something about that. * Remove .py suffixes from headings, as the examples folder is now full of folders, not modules. * Remove talk of running a fixed set of integration tests against an arbitrary example, which is no longer supported, if it ever was.
2 participants
De-emphasize the SDK-demoing-itself use case.
uv syncinstructions from CONTRIBUTING. Also,make helpdoesn't verify anything. Perhaps it once did.