diff --git a/lunadev/README.md b/lunadev/README.md index 9ae3a55d..5acea4d7 100644 --- a/lunadev/README.md +++ b/lunadev/README.md @@ -4,15 +4,15 @@ This is where the code to generate the `luna` image resides. `luna` is automatic ## VNC -VNC is a remote desktop protocol. Basically, it allows Lunadev to share its screen to you so that you can run applications like RViz2 which visualize a lot of data. This is very important for developing our autonomous actions. To start using VNC, you first need to [get VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/). Then, you need to download the `client_tunnel.py` script in this folder. You only need to download that file and nothing else. Now, check that you have added public key authentication for your SSH account (refer to the README at the root of this repository). Finallly, inside the DevContainer on Lunaserver, run `startvnc`. It will print out a one-time password that you should copy. +VNC is a remote desktop protocol. Basically, it allows Lunadev to share its screen to you so that you can run applications like RViz2 which visualize a lot of data. This is very important for developing our autonomous actions. To start using VNC, you first need to [get VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/). Then, you need to download the `client_vnc.py` script in this folder. You only need to download that file and nothing else. Now, check that you have added public key authentication for your SSH account (refer to the README at the root of this repository). Finallly, inside the DevContainer on Lunaserver, run `startvnc`. It will print out a one-time password that you should copy. Now, run the following command on your own computer: -`python3 client_tunnel.py YOUR_USERNAME LUNASERVER_ADDR LUNASERVER_PORT YOUR_PRIVATE_KEY` +`python3 client_vnc.py YOUR_USERNAME YOUR_PRIVATE_KEY` -Replace `YOUR_USERNAME` with your username on Lunaserver, `LUNASERVER_ADDR` and `LUNASERVER_PORT` with Lunaserver's current address and port, and `YOUR_PRIVATE_KEY` with the path to your private key on your computer (On windows, your keys are usually in `C:\Users\YOUR_NAME\.ssh`). An example of a proper command is as follows: +Replace `YOUR_USERNAME` with your username on Lunaserver, and `YOUR_PRIVATE_KEY` with the path to your private key on your computer (On windows, your keys are usually in `C:\Users\YOUR_NAME\.ssh`). An example of a proper command is as follows: -`python3 client_tunnel.py naj 0.tcp.us-cal-1.ngrok.io 11800 C:\Users\Najman\.ssh\lunaserver_private_key` +`python3 client_vnc.py naj C:\Users\Najman\.ssh\lunaserver_private_key` Keep in mind that the address and port written here may not be up to date.