Skip to content

Commit 872f30a

Browse files
committed
add setup gif
Signed-off-by: shmck <shawn.j.mckay@gmail.com>
1 parent 65d71d8 commit 872f30a

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,16 @@ CodeRoad is a VSCode extension that allows you to create and play interactive co
3434

3535
### Start
3636

37+
![CodeRoad Example](./docs/static/gif/launch-coderoad.gif)
38+
3739
To start the extension, inside VSCode:
3840

3941
- Open an **empty** VSCode workspace (a project folder)
4042
- Launch the app from the VSCode command palette. How?
43+
4144
- select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
4245
- in the command palette popup, search for and run `CodeRoad:Start`
4346

44-
## Contact & Support
45-
46-
- Create a GitHub issue for bug reports, feature requests, or questions
47-
- See [the docs](http://coderoad.github.io/docs/development) on how to run this project locally for development
48-
- Leave [a review](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad&ssr=false#review-details) in the VSCode Marketplace
49-
- Add a ⭐️ star on GitHub to support the project!
50-
- Reach out at `coderoadapp@gmail.com`
51-
5247
## Contributing
5348

5449
CodeRoad is an ambitious project, we're always looking for contributors :)
@@ -58,3 +53,11 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md).
5853
## License
5954

6055
[AGPL v3](./LICENSE.md)
56+
57+
## Contact & Support
58+
59+
- Create a GitHub issue for bug reports, feature requests, or questions
60+
- See [the docs](http://coderoad.github.io/docs/development) on how to run this project locally for development
61+
- Reach out at `coderoadapp@gmail.com`
62+
- Leave [a review](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad&ssr=false#review-details) in the VSCode Marketplace
63+
- Add a ⭐️ star on GitHub to support the project!

docs/docs/setup.md

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Once installed, reload the window (`ctrl/cmd + R`) to get started.
1818

1919
### Start
2020

21+
![CodeRoad Example](/gif/coderoad-example.gif)
22+
2123
To start the extension, inside VSCode:
2224

2325
- Open an **empty** VSCode workspace (a project folder)

docs/static/gif/launch-coderoad.gif

947 KB
Loading

0 commit comments

Comments
 (0)