Skip to content

Commit 80fcbbc

Browse files
committed
Improve README.md for clarity
1 parent a7fa98f commit 80fcbbc

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,14 @@ available [here](https://docs.docker.com/engine/install/).
1717
Then, you will need to set up the [`forklift`](https://github.com/PlanktoScope/forklift) tool on
1818
your computer. Setup instructions are available
1919
[here](https://github.com/PlanktoScope/forklift?tab=readme-ov-file#downloadinstall-forklift). Note
20-
that currently `forklift` is only tested for Linux computers.
20+
that currently `forklift` is only tested for Linux computers, and that Forklift is still an
21+
experimental prototype.
2122

2223
### Deployment
2324

2425
The instructions below assume that you are using a version of the `forklift` tool which is greater
25-
than or equal to v0.7.0 (but less than v0.8.0, which has not yet been released yet); other versions
26-
of the `forklift` tool may behave differently and thus may require different commands than what is
26+
than or equal to v0.7.0 (but less than v0.8.0, which has not been released yet); other versions of
27+
the `forklift` tool may behave differently and thus may require different commands than what is
2728
described below:
2829

2930
#### First-time deployment
@@ -39,8 +40,8 @@ specified by this pallet and delete any Docker containers not specified by this
3940
deployments.
4041

4142
If your user is [in the `docker` group](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)
42-
(so that you don't need to use `sudo` when running `docker` commands), then you can avoid using
43-
`sudo` with the `forklift` command:
43+
(so that you don't need to use `sudo` when running `docker` commands), then you don't need to use
44+
`sudo` with `forklift`:
4445

4546
```
4647
forklift pallet switch --apply github.com/PlanktoScope/pallet-segmenter@edge
@@ -72,7 +73,7 @@ forklift stage apply
7273

7374
After you have applied the pallet so that the containers are running, you can access the Node-RED
7475
dashboard from your web browser at <http://localhost:1880/ui>, or you can programmatically interact
75-
with the segmenter over MQTT via <mqtt://localhost:1883> (e.g. using
76+
with the segmenter over MQTT via `mqtt://localhost:1883` (e.g. using
7677
[github.com/PlanktoScope/cli](https://github.com/PlanktoScope/cli)).
7778
You can also access the Node-RED dashboard editor from your web browser at
7879
<http://localhost:1880/admin>.
@@ -87,10 +88,9 @@ used for running the segmenter) will be to use the filebrowser app in your web b
8788

8889
Before you can use the Node-RED dashboard, you will need to create a folder at
8990
`~/.local/share/planktoscope/data/img` (which you can do by just using the filebrowser app to create
90-
a new folder named `img` in the top level, at <http://localhost:9000/files/>), and then you should
91-
upload/copy your input datasets into that folder. Then you can press the "Update acquisition's
92-
folder list" button in the Node-RED dashboard, which should cause your input datasets to be listed
93-
in the dashboard.
91+
a new folder named `img` at <http://localhost:9000/files/>), and then you should upload/copy your
92+
input datasets into that folder. Then you can press the "Update acquisition's folder list" button in
93+
the Node-RED dashboard, which should cause your input datasets to be listed in the dashboard.
9494

9595
### Forking
9696

0 commit comments

Comments
 (0)