Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matifali committed Jun 3, 2024
1 parent 69e5e2d commit 4bc002f
Showing 1 changed file with 13 additions and 43 deletions.
56 changes: 13 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,11 @@
# [Coder](https://github.com/coder/coder) OSS templates
# Coder [^1] OSS templates

Docker-based templates.

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)
1. [deeplearning](https://github.com/matifali/coder-templates/tree/master/deeplearning) (`tensorflow` + `pytorch` + `numpy` + `matplotlib` + `pandas` + `conda` + `pip` + `jupyter`)
2. [deeplearning-nvidia](https://github.com/matifali/coder-templates/tree/master/deeplearning-nvidia) (Nvidia NGC containers)
3. [matlab](https://github.com/matifali/coder-templates/tree/master/matlab) (MATLAB docker images)

## Pre-requisites

[Coder](https://github.com/coder/coder) deployment set up on `CODER_URL` (e.g. https://coder.example.com)

## Installation

### Linux / MacOS

1. Open a terminal and run

```bash
curl -L https://coder.com/install.sh | sh
```

### Windows

1. Open a `powershell` window and run

```powershell
winget install Coder.Coder
```

## Instructions

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

### Automatic

Set up the following Github secrets in your repo.

1. `CODER_ACCESS_TOKEN` - Coder access token

To create a token with life of 1 year, run,

```shell
coder tokens create --lifetime 8760h0m0s
```

2. `CODER_URL` - Coder deployment url (e.g. https://coder.example.com)
Create a GitHub workflow to automatically update the templates. Use the **Update Coder Template**[^2] action.

## Deeplearning Images

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

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

## MATLAB Image

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

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

## Contributing

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

## Credits

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

0 comments on commit 4bc002f

Please sign in to comment.