From 2bfd653b5dff6a1efded7c5eb1dfd2df23f89f4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=B2=20Vescera?= Date: Wed, 10 May 2023 15:52:48 +0200 Subject: [PATCH 1/4] doc: Add docs for Codespaces Added a subsection of 'Setup for a project' named 'Run inside GihHub Codespaces' in where is explained how to setup the devcontainer inside a GitHub Codespace. Fix #51 --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index a9af877..9b51dca 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,43 @@ [![Install](https://i.imgur.com/1NJHIbH.gif)](https://github.com/qdm12/latexdevcontainer#setup-for-a-project) +### Run inside GitHub Codespaces + +Remebere, if you are running this devcontainer inside a GitHub Codespace, you have to uncomment the following +linse from the `docker-compose.yml` file: + +```diff +version: "3.2" + +services: + vscode: + build: . + image: latexdevcontainer + volumes: + - ../:/workspace + # Docker socket to access Docker server + - /var/run/docker.sock:/var/run/docker.sock + # SSH directory +- - ~/.ssh:/root/.ssh ++ # - ~/.ssh:/root/.ssh + # For Windows without WSL, a copy will be made + # from /tmp/.ssh to ~/.ssh to fix permissions +- - ~/.ssh:/tmp/.ssh:ro ++ # - ~/.ssh:/tmp/.ssh:ro + # Shell history persistence +- - ~/.zsh_history:/root/.zsh_history:z ++ # - ~/.zsh_history:/root/.zsh_history:z + # Git config +- - ~/.gitconfig:/root/.gitconfig ++ # - ~/.gitconfig:/root/.gitconfig + environment: + - TZ= + entrypoint: ["zsh", "-c", "while sleep 1000; do :; done"] +``` + +You have to do this because inside a Codespace there are no files like `~/.ssh:/root/.ssh` +or `~/.zsh_history:/root/.zsh_history:z` + ## Install LaTex packages If you need for example the package `lastpage`, open the integrated terminal in VS Code, select `zsh` and enter: From 4035ae84183590c2f3a85ba3305c0c682e1e7bf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=B2=20Vescera?= Date: Sat, 20 May 2023 16:29:33 +0200 Subject: [PATCH 2/4] fix: Typo Fixed a typo inside 'Run inside GitHub Codespaces' section Co-authored-by: Quentin McGaw --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b51dca..813180f 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ ### Run inside GitHub Codespaces -Remebere, if you are running this devcontainer inside a GitHub Codespace, you have to uncomment the following +Remember, if you are running this devcontainer inside a GitHub Codespace, you have to uncomment the following linse from the `docker-compose.yml` file: ```diff From fea66435041c4f339255d8fa1e1d2601ed53cd7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=B2=20Vescera?= Date: Sat, 20 May 2023 16:30:57 +0200 Subject: [PATCH 3/4] fix: Typo Co-authored-by: Quentin McGaw --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 813180f..5512a98 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ services: ``` You have to do this because inside a Codespace there are no files like `~/.ssh:/root/.ssh` -or `~/.zsh_history:/root/.zsh_history:z` +or `~/.zsh_history` ## Install LaTex packages From ab36342f342449e7db83ae5bf93c8ea050f49f7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=B2=20Vescera?= Date: Sat, 20 May 2023 16:43:17 +0200 Subject: [PATCH 4/4] fix: Typo Co-authored-by: Quentin McGaw --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5512a98..46e56f3 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ ### Run inside GitHub Codespaces Remember, if you are running this devcontainer inside a GitHub Codespace, you have to uncomment the following -linse from the `docker-compose.yml` file: +line from `.devcontainer/docker-compose.yml`: ```diff version: "3.2"