pzp
/
zooboard
mirror of https://codeberg.org/pzp/zooboard.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More instructions in readme

This commit is contained in:
Jacob Karlsson 2024-04-18 13:10:38 +02:00
parent 9e679b5902
commit eddecbe017
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,8 +1,21 @@
# Zooboard # Zooboard
To develop: To run it yourself:
1. `npm install` 1. `npm install`
2. `npm start` in one terminal, `npm run electron` in another 2. Download, install, and run [pzp-hub][pzp-hub].
3. Edit JS code 3. In the zooboard repo, `npm run start-all`
4. Sometimes you may need to re-run step 2
To run with a friend:
1. Both `npm install`
2. One of you downloads, installs, and runs [pzp-hub][pzp-hub] on a machine with a public IP.
3. You both, in the zooboard repo, run `npm start` in one terminal and `npm run electron` in another.
To use:
1. One peer goes to the hub website (default on localhost is [0.0.0.0:3000](http://0.0.0.0:3000)), gets the admin invite, and uses it in the app by clicking "Join".
2. That peer clicks "Invite" in the app and gives that invite to the other peer.
3. The other peer uses that invite by clicking "Join".
4. Draw together and be happy!
5. [Discuss bugs here](https://codeberg.org/pzp/pzp-hub/issues) or pzp in general on the #pzp hashtag on your preferred social network.
[pzp-hub]: https://codeberg.org/pzp/pzp-hub