|
1 | 1 | # Acknowledgements
|
2 | 2 |
|
3 |
| -Thanks to [dinfuehr](https://gist.github.com/dinfuehr) for providing [cacao-jvm-dockerfile](https://gist.github.com/dinfuehr/ab83ad825cd24be0e816588d0465a7fb), which is the core of this repository. |
| 3 | +Thanks to [dinfuehr](https://gist.github.com/dinfuehr) for providing [cacao-jvm-dockerfile](https://gist.github.com/dinfuehr/ab83ad825cd24be0e816588d0465a7fb), on which this guide is based. |
4 | 4 |
|
5 | 5 | # What is this?
|
6 | 6 |
|
7 |
| -This guide summarizes the setup of a [cacaojvm](http://www.cacaojvm.org/) dev container using Windows 10 with docker. In theory a similar approach should work on Linux based systems, if you want to isolate your cacao-dev environment from your day-to-day system. |
| 7 | +This guide summarizes the setup of a [cacaojvm](http://www.cacaojvm.org/) dev container using Windows 10 with docker. |
8 | 8 |
|
9 |
| -This repository solely extends the gist provided by [dinfuehr](https://gist.github.com/dinfuehr) with an "Getting Started" installation guide. |
| 9 | +In theory a similar approach should work on Linux based systems, if you want to isolate your cacao-dev environment from your day-to-day system. |
10 | 10 |
|
11 | 11 | Tools used in this guide:
|
12 | 12 | * Windows 10 Pro
|
13 | 13 | * docker for Desktop
|
14 | 14 | * Visual Studio Code
|
15 |
| - * [Remote - Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) |
| 15 | + * [Remote - Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) |
16 | 16 |
|
17 | 17 | # Getting Started
|
18 | 18 |
|
19 | 19 | * Fork the repository using your BitBucket account. [Further information](http://c1.complang.tuwien.ac.at/cacaowiki/Draft/CodeSubmissionProcess?action=show&redirect=Contributing) on the code submission process.
|
20 |
| -* Clone the forked repository into a well known location (e.g. `C:\Development`) |
| 20 | +* Change the mercurial repository link in the docker file (`RUN hg clone https://bitbucket.org/cacaovm/cacao-staging`) to your forked repository. |
21 | 21 | * Open VS Code
|
22 |
| -* Open the cacao folder in the dev container |
23 |
| - * Press F1 to open the command palette. |
24 |
| - * Execute the command `Remove-Containers: Open Folder in Container` |
25 |
| - * Select the folder created through cloning this repository in Step #1. |
26 |
| -* Let VS Code do the rest |
27 |
| - * VS Code will setup the container for you |
| 22 | +* Create the dev container |
| 23 | + * Press F1 to open the command palette. |
| 24 | + * Execute the command `Remove-Containers: Reopen in Container` |
| 25 | +* VS Code/docker will setup the container for you |
28 | 26 | * Verify the installation
|
29 |
| - * Toggle the integrated terminal |
30 |
| - * Open a new bash shell |
31 |
| - * Try to locate the `cacao-staging` repository under `/code/cacao-staging` |
32 |
| -* You should now be able to use the `Open Folder` command to open the folder `/code` in the container |
| 27 | + * Toggle the integrated terminal |
| 28 | + * Open a new bash shell |
| 29 | + * Try to locate the `cacao-staging` repository under `/code/cacao-staging` |
| 30 | +* You should now be able to use the `Open Folder` command to open the folder `/code` in the container |
| 31 | +* Validate the environment by invoking `make check` in the `/code/build` directory |
0 commit comments