Skip to content

Commit

Permalink
Merge pull request #56 from ewilliams0305/readme-examples
Browse files Browse the repository at this point in the history
created room guide
  • Loading branch information
ewilliams0305 committed Dec 30, 2023
2 parents 290d776 + ba34b48 commit 1b78774
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,23 @@ Users can start, stop, enable/disable debugging, and restart rooms. All room CR
![Readme Image](./docs/rooms.gif)

### Add and remove rooms
Navigate to the rooms menu and press 'ctrl+n' to select a program from the program library. OR, navigate to the program menu and press 'ctrl+r' to create a new room instance from the highlighted program.

![CREATE ROOM](./docs/add_room.gif)

## 🧑‍💻 Programs
Users can create, edit, and delete program entries. users can also spin up rooms from either the program view or the room interface.

### Creating Programs
Navigate to the program menu and press 'ctrl+n'. Complete the form with at minumum a specified file path and a name. Note the file path is relative the execution of the vcli, when running on you local machine file specify a file on you local file system, when running on the VC4 server specify a file path on the server.

![CREATE PROGRAM](./docs/add_prog.gif)

### Deleting Programs

Navigate to the program menu, with the program highlighted press ctrl+d or the delete key. When prompted selected yes to delete the program and any effected rooms.

As of v0.0.2 users can upload new program files to the system. Users can
create, edit, and delete program entries. users can also spin up rooms from either the program view or the room interface.
![DELETE PROGRAM](./docs/del_prog.gif)

## ⚖️ Authorization and Licenses

Expand Down
Binary file added docs/add_prog.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/add_room.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/del_prog.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1b78774

Please sign in to comment.