An operating function (Prototype)
Go to file
2024-07-03 17:56:26 +01:00
.github ci: fix ci on next/kelvin/412 branch 2023-07-19 17:04:20 +03:00
bin gall: fix high water marks for nuked agents 2023-12-11 14:49:08 -05:00
doc/spec Revert "removing old Nock specs" 2022-11-30 12:55:16 -05:00
extras Misc cleanup blocking CC-Release. (#1249) 2019-04-24 17:27:27 -07:00
nix ci: fix ci nonsense 2024-04-16 16:16:14 +03:00
pkg Add developer environment guide (#76) 2024-07-02 19:23:58 +01:00
sh ci: fix ci on next/kelvin/412 branch 2023-07-19 17:04:20 +03:00
tests Merge remote-tracking branch 'upstream/master' into dev-summit 2024-06-17 14:31:48 -04:00
.gitattributes meta: enforce LF newlines for all hoon and hoon related files 2021-11-25 10:58:21 -05:00
.gitignore devex: update zest.pike comment 2022-11-05 01:45:57 -07:00
.ignore Can now |hi to King Haskell over Ames! (and merged Master) 2019-07-31 22:16:02 -07:00
.mailmap mailmap: add pkova [ci skip] 2020-01-30 15:53:19 +04:00
.stylish-haskell.yaml stylish-haskell 2019-07-12 12:27:15 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md 2023-05-24 11:40:45 -04:00
default.nix Merge branch 'develop' into lf/goerli-address 2023-02-09 06:57:19 -08:00
flake.lock ci: fix ci on next/kelvin/412 branch 2023-07-19 17:04:20 +03:00
flake.nix ci: make tests actually run in ci 2024-02-23 00:01:35 +02:00
LICENSE.txt Restore toplevel LICENSE.txt file. 2020-01-28 13:24:39 -08:00
MAINTAINERS.md meta: don't codeblock table in MAINTAINERS.md 2023-04-29 07:36:28 -05:00
Makefile arvo: retool for goerli instead of deprecated ropsten 2022-10-26 13:11:22 +10:00
README.md Update README with dev env setup guide 2024-07-03 17:56:26 +01:00
shell.nix build: removes herb from top-level Makefile, shell.nix 2022-06-03 14:40:08 -04:00
test-desk.bill ci: fix ci on next/kelvin/412 branch 2023-07-19 17:04:20 +03:00
vere-version ci: update vere-version 2023-01-18 14:54:59 -07:00

Developer Environment Setup

The quickest way to get set up to play with Shrubbery and Sky is to boot a comet and run |install ~met %neo. You could also boot a moon for this.

When you boot your ship 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.

If you want to work from the GitHub repo…

  • Clone urbit/shrub to your machine. (The develop branch is the latest stable build.)
  • Boot a fakeship
  • > |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>/neo/sky to access Sky.

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 make a change to a /pro file you'll have to |nuke %neo and |revive %neo.