Skip to content

Commit 75a9ac3

Browse files
authored
Update README.md
1 parent 590fe76 commit 75a9ac3

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
## Usage Guidelines
1111

1212
TLDR: Search for `todo` and update all occurrences to your desired name
13+
1314
Docker and singularity is not a must unless you cannot install some dependencies locally on HPC shell environment due to permission issue
1415

1516
### Base Repo
@@ -43,7 +44,7 @@ Docker and singularity is not a must unless you cannot install some dependencies
4344

4445
1. To run and test a built image, use [run_docker_container.sh](scripts/run_docker_container.sh) or `docker compose up -d`
4546

46-
- The service by default will mount the whole repository onto `CODE_FOLDER` inside the container so any modification inside also takes effect outside, which is useful when you use vscode remote extension to develop inside a running container with docker context
47+
- The service by default will mount the whole repository onto `CODE_FOLDER` inside the container so any modification inside also takes effect outside, which is useful when you use vscode remote extension to develop inside a running container with remote docker context
4748

4849
1. [push_docker_image.sh](scripts/push_docker_image.sh) to push the multi-arch image to docker hub
4950

@@ -69,7 +70,7 @@ Docker and singularity is not a must unless you cannot install some dependencies
6970

7071
1. Submit job by `sbatch jobs/your-cluster/your-job.job` or `jobs/your-cluster/your-job.job`
7172

72-
1. Recommend [turm](https://github.com/kabouzeid/turm) for job monitor, use `turn -u your-slurm-user` after installation
73+
1. Recommend [turm](https://github.com/kabouzeid/turm) for job monitor, use `turm -u your-slurm-user` after installation
7374

7475
## Developer Quick Start
7576

0 commit comments

Comments
 (0)