shrub/README.md

Developer Environment Setup

urbit/shrub is alpha software that should not be booted on a live ship. Boot a fakeship to try it out.

When you boot your fakeship you should use the --loom 33 flag, which allocates 8GB of memory on your machine for your ship. During Shrubbery development you could end up nuking and restarting the %neo agent many times, which will quickly use up the 2GB of memory ships are allocated by default. If/when your ship runs out of memory, just boot a new one and copy your work into that.

• Clone urbit/shrub to your machine. (The develop branch is the latest stable build.)
• Boot a fakeship with the --loom 33 flag.
• > |new-desk %neo on the fakeship
• > |mount %neo
• $ rsync -avL path/to/pkg/shrub/* path/to/fakeship/neo
• > |commit %neo
• > |install our %neo

This will start the %neo agent which runs the Shrubbery prototype. Once that's finished booting, which will take a few minutes, go to <localhost:port>/mast/mast-sky-ui/<fakeship @p>/sky to access Sky.

Once you're in Sky, click the "docs" tile to find documentation, which includes tutorials and reference material for developers.

When you want to move changes from your local repo to the fakeship, repeat the rsync -avL command above. The %neo agent can do incremental builds and will make changes to your /con and /imp files as you'd expect, but if you add or amend a /pro file you'll have to |nuke %neo and |revive %neo.