Skip to content

Commit

Permalink
doc: Add docs for Codespaces
Browse files Browse the repository at this point in the history
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
  • Loading branch information
ncvescera committed May 10, 2023
1 parent a84253c commit 2bfd653
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 2bfd653

Please sign in to comment.