Skip to content

Commit de53818

Browse files
authored
Update README.md (#15)
1 parent d677da5 commit de53818

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
# OpenDream for Visual Studio Code
22

3-
Work-in-progress extension for VSC to add task runner and debugger support for
3+
An extension for VSCode to add task runner and debugger support for
44
[OpenDream](https://github.com/OpenDreamProject/).
55

66
Best used in combination with [DreamMaker Language Client](https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient).
77

8+
## Features
9+
10+
- Full VSCode debugger integration (breakpoints, stepping, variable inspection, etc.)
11+
- Automatic management of required binaries, including downloading releases from Github or compiling from source as appropriate
12+
- Hot reloading of interface and resource files
13+
14+
## How To Use
15+
16+
Simply install the extension, open a folder containing your DME file, and start debugging. The extension will automatically grab the latest releases of OpenDream and the SS14 Launcher, compile your DME, start the server and the client and connect them.
17+
Optionally, you can configure the path to your OpenDream source directory or add the OpenDream source directory to your workspace to compile from source instead.
18+
819
## License
920

1021
OpenDream for Visual Studio Code is free software: you can redistribute it and/or modify

0 commit comments

Comments
 (0)