Skip to content

Commit d5d5ba4

Browse files
committed
better readme
1 parent 41f470c commit d5d5ba4

File tree

1 file changed

+37
-8
lines changed

1 file changed

+37
-8
lines changed

README.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,45 @@
11
# DM Playground
22

3-
Clientside DM Playground built with Vite + React + TypeScript + Tailwind.
3+
This is the repository for the [DM Playground](https://play.dm-lang.org/).
44

5-
It runs a Linux VM in-browser via v86 and provides a Monaco editor with DM syntax highlighting.
5+
## What's it do?
66

7-
## Scripts
7+
The playground allows you to experiment with [DM](http://ref.dm-lang.org/) code purely in your browser.
88

9-
- npm run dev
10-
- npm run build
11-
- npm run preview
12-
- npm run lint
9+
It has a number of features, including:
1310

14-
## LICENSE
11+
1. A simple editor with themes and syntax highlighting.
12+
2. The ability to compile and run DM code against different [BYOND](https://www.byond.com/) versions.
13+
3. A built-in terminal for direct interaction with the underlying Linux VM.
14+
4. A quick-share function.
15+
16+
## Architecture
17+
18+
The frontend is powered by [React](https://reactjs.org/), while [v86](https://github.com/copy/v86) emulates x86 running a Linux environment where BYOND is installed. **Everything happens 100% client-side.**
19+
20+
## Development
21+
22+
### Build the UI
23+
24+
```bash
25+
npm install
26+
npm run dev # Starts development server with hot reload
27+
```
28+
29+
### Build for production
30+
31+
```bash
32+
npm run build # Type-check and build
33+
npm run preview # Preview production build
34+
```
35+
36+
### Code quality
37+
38+
```bash
39+
npm run lint # Run ESLint
40+
npm run format # Format code with Prettier
41+
```
42+
43+
## License
1544

1645
[MIT](./LICENSE)

0 commit comments

Comments
 (0)