Merge pull request #337 from urbit/i/322/app-guide-dev-desks-update

update quickstart & fullstack desk setup instructions
This commit is contained in:
tinnus-napbus 2023-04-12 19:07:12 +12:00 committed by GitHub
commit 749fca60bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 24 additions and 27 deletions

View File

@ -42,7 +42,7 @@ We only have one agent to start, so `desk.bill` is very simple:
Likewise, `sys.kelvin` just contains:
``` {% copy=true %}
[%zuse 417]
[%zuse 414]
```
The `desk.docket-0` file is slightly more complicated:
@ -118,8 +118,7 @@ Now we can browse to it in the unix terminal:
cd /path/to/zod/journal
```
Currently it has the same files as the `%webterm` desk, so we need to delete
those:
Currently it just contains some skeleton files, so we need to delete those:
```sh {% copy=true %}
rm -rI /path/to/zod/journal/*
@ -130,24 +129,25 @@ self-contained, including all mark files and libraries necessary to build them.
For example, since our app contains a number of `.hoon` files, we need the
`hoon.hoon` mark, and its dependencies. The easiest way to ensure our desk has
everything it needs is to copy in the "dev" versions of the `%base` and
`%garden` desks. To do this, we first clone the Urbit git repository:
`%garden` desks. To do this, we first clone the Urbit and Landscape git repositories:
```sh {% copy=true %}
git clone https://github.com/urbit/urbit.git urbit-git
git clone https://github.com/tloncorp/landscape.git landscape-git
```
If we navigate to the `pkg` directory in the cloned repo:
If we navigate to the `pkg` directory in the cloned `urbit` repo:
```sh {% copy=true %}
cd /path/to/urbit-git/pkg
```
...we can combine the `base-dev` and `garden-dev` desks with the included
`symbolic-merge.sh` script:
...we can combine the `base-dev` and Landscape `desk-dev` desks with the
included `symbolic-merge.sh` script:
```sh {% copy=true %}
./symbolic-merge.sh base-dev journal
./symbolic-merge.sh garden-dev journal
./symbolic-merge.sh ../../landscape-git/desk-dev journal
```
Now, we copy the contents of the new `journal` folder into our empty desk:
@ -156,8 +156,7 @@ Now, we copy the contents of the new `journal` folder into our empty desk:
cp -rL journal/* /path/to/zod/journal/
```
Note we've used the `L` flag to resolve symbolic links, because the dev-desks
contain symlinks to files in the actual `arvo` and `garden` folders.
Note we've used the `L` flag to resolve symbolic links.
We can copy across all of our own files too:

View File

@ -1595,7 +1595,7 @@ this by adding a `sys.kelvin` file to the root of our `hut` directory:
```shell {% copy=true %}
cd hut
echo "[%zuse 415]" > sys.kelvin
echo "[%zuse 414]" > sys.kelvin
```
We also need to specify which agents to start when our desk is installed. We do
@ -1635,10 +1635,10 @@ the moment.
## Put it together
Our app is now complete, so let's try it out. In the Dojo of our comet,
we'll create a new desk by forking from an existing one:
we'll create a new desk with the `|new-desk` generator:
``` {% copy=true %}
|merge %hut our %webterm
|new-desk %hut
```
Next, we'll mount the desk so we can access it from the host OS:
@ -1647,8 +1647,8 @@ Next, we'll mount the desk so we can access it from the host OS:
|mount %hut
```
Currently its contents are the same as the `%webterm` desk, so we'll need to
delete those files and copy in our own instead. In the normal shell, do the
It'll have a handful of skeleton files in it, but we can just delete those and
add our own instead. In the normal shell, do the
following:
```shell {% copy=true %}

View File

@ -1916,7 +1916,7 @@ this by adding a `sys.kelvin` file to the root of our `squad` directory:
```shell {% copy=true %}
cd squad
echo "[%zuse 417]" > sys.kelvin
echo "[%zuse 414]" > sys.kelvin
```
We also need to specify which agents to start when our desk is installed. We do
@ -1967,10 +1967,10 @@ squad
```
Let's now try it out. In the Dojo of our comet,
we'll create a new desk by forking from an existing one:
we'll create a new desk with the `|new-desk` generator:
``` {% copy=true %}
|merge %squad our %webterm
|new-desk %squad
```
Next, we'll mount the desk so we can access it from the host OS:
@ -1979,9 +1979,8 @@ Next, we'll mount the desk so we can access it from the host OS:
|mount %squad
```
Currently its contents are the same as the `%webterm` desk, so we'll need to
delete those files and copy in our own instead. In the normal shell, do the
following:
Currently it just contains some skeleton files, but we can just delete those
and add our own instead. In the normal shell, do the following:
```shell {% copy=true %}
rm -r dev-comet/squad/*

View File

@ -1902,7 +1902,7 @@ this by adding a `sys.kelvin` file to the root of our `tally` directory:
```shell {% copy=true %}
cd tally
echo "[%zuse 417]" > sys.kelvin
echo "[%zuse 414]" > sys.kelvin
```
We also need to specify which agents to start when our desk is installed. We do
@ -1933,10 +1933,10 @@ following:
## Put it together
Our app is now complete, so let's try it out. In the Dojo of our comet, we'll
create a new desk (filesystem repo) by forking from an existing one:
create a new desk with the `|new-desk` generator:
```{% copy=true %}
|merge %tally our %webterm
|new-desk %tally
```
Next, we'll mount the desk so we can access it from the host OS:
@ -1945,9 +1945,8 @@ Next, we'll mount the desk so we can access it from the host OS:
|mount %tally
```
Currently its contents are the same as the `%webterm` desk, so we'll need to
delete those files and copy in our own instead. In the normal shell, do the
following:
Currently it just contains some skeleton files, but we can delete those and add
our own instead. In the normal shell, do the following:
```shell {% copy=true %}
rm -r dev-comet/tally/*