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 install from source instructions to README #2443

Merged
merged 5 commits into from
Mar 14, 2025
Merged

Conversation

jdetter
Copy link
Collaborator

@jdetter jdetter commented Mar 12, 2025

Description of Changes

Please describe your change, mention any related tickets, and so on here.

Fixes #2420

Rendered view: https://github.com/clockworklabs/SpacetimeDB/blob/jdetter/docs/2420/README.md

API and ABI breaking changes

If this is an API or ABI breaking change, please apply the
corresponding GitHub label.

NA

Expected complexity level and risk

How complicated do you think these changes are? Grade on a scale from 1 to 5,
where 1 is a trivial change, and 5 is a deep-reaching and complex change.

This complexity rating applies not only to the complexity apparent in the diff,
but also to its interactions with existing and future code.

If you answered more than a 2, explain what is complex about the PR,
and what other components it interacts with in potentially concerning ways.

0 - just a docs update

Testing

Describe any testing you've done, and any testing you'd like your reviewers to do,
so that you're confident that all the changes work as expected!

  • I have ran all install instructions and verified that they're working correctly.
  • Linux install instructions
  • macOS install instructions - not tested but the Linux install instructions are identical and it worked on Linux
  • Windows install instructions

Sorry, something went wrong.

John Detter added 2 commits March 11, 2025 21:35
@jdetter jdetter force-pushed the jdetter/docs/2420 branch from e231586 to 04be020 Compare March 12, 2025 02:35
John Detter added 2 commits March 11, 2025 21:36
Copy link
Collaborator

@joshua-spacetime joshua-spacetime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you able to add the same message about adding ~/.local/bin to your path on macos that the install script does? Technically this would only matter for someone who has never used the official install script on macos.

Copy link
Collaborator

@joshua-spacetime joshua-spacetime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving, if you could just update the macos instructions before merging.

@jdetter
Copy link
Collaborator Author

jdetter commented Mar 14, 2025

I believe I've addressed everything here 👍

@jdetter jdetter enabled auto-merge March 14, 2025 00:18
@jdetter jdetter added this pull request to the merge queue Mar 14, 2025
Merged via the queue into master with commit 26c1387 Mar 14, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Instructions for building SpacetimeDB Standalone + spacetimedb-cli from master, put this into the README
2 participants