Skip to content

Commit 4bc002f

Browse files
committed
chore: Update README.md
1 parent 69e5e2d commit 4bc002f

File tree

1 file changed

+13
-43
lines changed

1 file changed

+13
-43
lines changed

README.md

Lines changed: 13 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,11 @@
1-
# [Coder](https://github.com/coder/coder) OSS templates
1+
# Coder [^1] OSS templates
22

33
Docker-based templates.
44

5-
1. [deeplearning](https://github.com/matifali/coder-templates/tree/master/deeplearning) (tensorflow + pytorch + numpy + matplotlib + pandas + conda + pip + jupyter notebook or jupyter lab + Microsoft code-server)
5+
1. [deeplearning](https://github.com/matifali/coder-templates/tree/master/deeplearning) (`tensorflow` + `pytorch` + `numpy` + `matplotlib` + `pandas` + `conda` + `pip` + `jupyter`)
66
2. [deeplearning-nvidia](https://github.com/matifali/coder-templates/tree/master/deeplearning-nvidia) (Nvidia NGC containers)
77
3. [matlab](https://github.com/matifali/coder-templates/tree/master/matlab) (MATLAB docker images)
88

9-
## Pre-requisites
10-
11-
[Coder](https://github.com/coder/coder) deployment set up on `CODER_URL` (e.g. https://coder.example.com)
12-
13-
## Installation
14-
15-
### Linux / MacOS
16-
17-
1. Open a terminal and run
18-
19-
```bash
20-
curl -L https://coder.com/install.sh | sh
21-
```
22-
23-
### Windows
24-
25-
1. Open a `powershell` window and run
26-
27-
```powershell
28-
winget install Coder.Coder
29-
```
30-
319
## Instructions
3210

3311
To use these templates simply clone the repo and run,
@@ -50,29 +28,19 @@ coder templates push <template-name>
5028

5129
### Automatic
5230

53-
Set up the following Github secrets in your repo.
54-
55-
1. `CODER_ACCESS_TOKEN` - Coder access token
56-
57-
To create a token with life of 1 year, run,
58-
59-
```shell
60-
coder tokens create --lifetime 8760h0m0s
61-
```
62-
63-
2. `CODER_URL` - Coder deployment url (e.g. https://coder.example.com)
31+
Create a GitHub workflow to automatically update the templates. Use the **Update Coder Template**[^2] action.
6432

6533
## Deeplearning Images
6634

67-
Deeplearning images used in the template are available at [dockerhub](https://hub.docker.com/repository/docker/matifali/dockerdl).
35+
Deeplearning images used in the template are available at dockerhub[^3].
6836

69-
Source code of deeplearning images is available at, [https://github.com/matifali/dockerdl](https://github.com/matifali/dockerdl)
37+
Source code of deeplearning images is available here[^4].
7038

7139
## MATLAB Image
7240

73-
MATLAB images used in the template is available at [dockerhub](https://hub.docker.com/repository/docker/matifali/matlab).
41+
MATLAB images used in the template is available at dockerhub[^5].
7442

75-
Source code for the matlab docker image is available at [https://github.com/matifali/matlab](https://github.com/matifali/matlab)
43+
Source code for the matlab docker image is available here[^6].
7644

7745
## Contributing
7846

@@ -84,7 +52,9 @@ Contributions are welcome. Please open an issue or a pull request. Thanks!
8452

8553
## Credits
8654

87-
- [Coder](https://github.com/coder/coder)
88-
- [MATLAB Docker Images](https://hub.docker.com/r/matlab/matlab)
89-
- [Nvidia NGC containers](https://ngc.nvidia.com/catalog/containers)
90-
- [Update Coder Template](https://github.com/marketplace/actions/update-coder-template)
55+
[^1]: [Coder](https://github.com/coder/coder)
56+
[^2]: [Update Coder Template](https://github.com/marketplace/actions/update-coder-template)
57+
[^3]: [dockerdl images](https://hub.docker.com/repository/docker/matifali/dockerdl)
58+
[^4]: [dockerdl source](https://github.com/matifali/dockerdl)
59+
[^5]: [matlab images](https://hub.docker.com/repository/docker/matifali/matlab)
60+
[^6]: [matlab source](https://github.com/matifali/matlab)

0 commit comments

Comments
 (0)