Skip to content

Commit d7dad43

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

File tree

1 file changed

+23
-37
lines changed

1 file changed

+23
-37
lines changed

readme.md

Lines changed: 23 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,34 @@
1-
# kode-Runner
1+
# Welcome to Kode-Runner, the interactive code environment brought to you by Finite!
22

3-
Welcome to Runner! the interactive code enviroment brought to you by Finite
3+
Kode-Runner is a versatile tool that lets you run code in various languages and see the output in real-time. It’s ideal for testing code snippets or running scripts.
4+
How to Use
45

5-
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.
6+
Get the Docker Image: Pull the Kode-Runner Docker image from the releases.
7+
Run the Docker Container: Start the container on port 5000.
8+
Connect to the Client: In-game, spawn the Kode client or any supported client using the following URL: resrec:///G-pussafire/R-7EDF219CF4884A1144CBB4F2A9FA271C7581CF20BFCC7AA10624ECC84998F18D. Click the purple connection button.
9+
Connect: After a few seconds, you should be connected!
610

7-
## Usage
11+
Features
812

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!
13+
Multi-Language Support: Run code in languages like Python, C, C++, and more.
14+
Real-Time Output: See your code’s output as it executes.
15+
Interactive Terminal: Engage with a fully interactive terminal.
16+
Safe and Isolated: Runs code in a Docker container for security.
17+
User-Friendly: Simple and intuitive interface.
1218

19+
Best of all, Kode-Runner is open source and free to use!
20+
Contributing
1321

14-
## Features
22+
Want to contribute to Kode-Runner? Feel free to fork the repository and submit a pull request. We welcome contributions, including bug fixes, new features, and documentation improvements.
1523

16-
- Run code in a variety of languages, including Python, C, C++, and more
17-
- See the output in real time
18-
- Fully interactive terminal
19-
- Run code in a safe, isolated environment using Docker
20-
- Easy to use, with a simple and intuitive interface
24+
For more details, please check the CONTRIBUTING.md file.
25+
What is Kode-Runner?
2126

22-
best part about this, is that it is all open source and free to use!
27+
Have you ever wanted to execute text-based code inside Resonite? Now you can!
2328

29+
Kode-Runner is a hardware/server solution that allows you to run languages like Python, C, and C++ within Resonite. It includes features like real-time output and a fully interactive terminal.
2430

25-
## Contributing
26-
27-
If you would like to contribute to Runner, please feel free to fork the repository and submit a pull request. We welcome contributions of all kinds, including bug fixes, new features, and improvements to the documentation.
28-
29-
if you need more infomation, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
30-
31-
## what is this?
32-
33-
ever wondered if you could literly type out text based languages inside of resonite and it just works?
34-
35-
well now you can!
36-
37-
code runner is a hardware/server duo that allows you to run python, c, c++ ect within resonite while still including the goodies such as watching cargo run take 24 hours because tokio hung itself for the 20th time today.
38-
39-
code features a fully interactive terminal that allows you to run anything you wish*
40-
41-
runner works through a docker container to run the code directly inside the docker container for safety and proformance*
42-
43-
## how does it work?
44-
45-
using websockets and a python server, we can run code inside of a docker container and send the output back to the client in real time.
46-
47-
this also allows for streaming a terminal to the client, allowing for a fully interactive terminal experience.
31+
Kode-Runner uses a Docker container to ensure safety and performance while running your code.
32+
How Does It Work?
4833

34+
We utilize WebSockets and a Python server to execute code inside a Docker container and send the output back to the client in real-time. This setup allows for streaming a terminal to the client, providing a fully interactive coding experience.

0 commit comments

Comments
 (0)