Skip to content

Commit 6b57f2a

Browse files
authored
Update readme.md
1 parent 71268a8 commit 6b57f2a

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

readme.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,15 @@
1-
# CodeRunner
1+
# kode-Runner
22

3-
Welcome to Runner! the interactive code enviroment brought to you by OpenStudio!
3+
Welcome to Runner! the interactive code enviroment brought to you by Finite
44

55
Runner is a simple, yet powerful tool that allows you to run code in a variety of languages, and see the output in real time. It's perfect for testing out code snippets, or for running scripts.
66

77
## Usage
88

9-
clone the repo and cd into the runner directory.
9+
using the releases of the runner docker container, pull the image then spin one of them up on port 5000.
10+
ingame, spawn out the kode client or any supported client from `resrec:///G-pussafire/R-7EDF219CF4884A1144CBB4F2A9FA271C7581CF20BFCC7AA10624ECC84998F18D` and hit the purple colored connection button.
11+
after a few secconds, you should be connected!
1012

11-
run `lib/main.py` on a linux system or wsl. sorry windows.
12-
spawn out Code from Charlie's public folder inside of a world in resonite and hit the purple button to connect to the server.
13-
once you hear tada.wav, you are connected and can start running code.
14-
15-
type the code inside the main code box or drop one of the demo code files into the import area under the left monitor and click the green run button at the top right hand side of the window.
16-
the output will appear in the output window on the left monitor.
17-
18-
this assumes that the UI theme issue hasn't been completed yet or you are using the default client included with the server.
1913

2014
## Features
2115

@@ -27,14 +21,6 @@ this assumes that the UI theme issue hasn't been completed yet or you are using
2721

2822
best part about this, is that it is all open source and free to use!
2923

30-
if your docker container gets destroyed, you can rebuild it by running the following command in the runner directory:
31-
32-
```bash
33-
docker build -t runner .
34-
```
35-
36-
this will rebuild the docker container and you can run the server again.
37-
3824

3925
## Contributing
4026

@@ -60,7 +46,3 @@ using websockets and a python server, we can run code inside of a docker contain
6046

6147
this also allows for streaming a terminal to the client, allowing for a fully interactive terminal experience.
6248

63-
:DISCLAMER:
64-
please know that this can allow arbatrary code execution on your system in the included docker container.
65-
though it is running inside the container, just put caution.
66-
:DISCLAMER:

0 commit comments

Comments
 (0)