Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for in-container development with Visual Studio Code on Windows and Docker #227

Merged
merged 2 commits into from
Dec 14, 2023
Merged

Update documentation for in-container development with Visual Studio Code on Windows and Docker #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30f927c
Update documentation, adding instructions to run Viking on Windows in…
starnutoditopo Dec 13, 2023
c3e06b7
Solve #228 (add yaru-theme-icon package)
starnutoditopo Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"image": "mcr.microsoft.com/devcontainers/universal:2",
"features": {
"ghcr.io/akhildevelops/devcontainer-features/apt:0": {
"PACKAGES": "gtk-doc-tools docbook-xsl yelp-tools libpng-dev libgtk-3-dev libicu-dev libjson-glib-dev intltool autopoint xxd libcurl4-gnutls-dev libglib2.0-dev-bin libsqlite3-dev nettle-dev libmapnik-dev libgeoclue-2-dev libgexiv2-dev libgps-dev libmagic-dev libbz2-dev libzip-dev liboauth-dev libnova-dev"
"PACKAGES": "gtk-doc-tools docbook-xsl yelp-tools libpng-dev libgtk-3-dev libicu-dev libjson-glib-dev intltool autopoint xxd libcurl4-gnutls-dev libglib2.0-dev-bin libsqlite3-dev nettle-dev libmapnik-dev libgeoclue-2-dev libgexiv2-dev libgps-dev libmagic-dev libbz2-dev libzip-dev liboauth-dev libnova-dev yaru-theme-icon"
}
},
"mounts": [
Expand Down
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,13 @@ First, read [hacking notes](HACKING).

In order to ease the creation of a development environment, there is a [development container]() description in `.devcontainer/devcontainer.json`.
This file can be used in different tools, like [Visual Studio Code](https://code.visualstudio.com/docs/devcontainers/tutorial) or to create online environments [Github Codespaces](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).

### In-container development with Visual Studio Code on Windows

On Windows, install an X server (such as [VcXsrv](http://vcxsrv.sourceforge.net)) and run it **disabling the access control**.

Make sure Docker is running.

Run Visual Studio Code and "open in container" the directory containing the Viking's source code.

You should now be able to compile, install and run Viking from Visual Studio Code's terminal; the application is displaied as a normal window, through the X server.