Skip to content

Commit

Permalink
Reorganize repo
Browse files Browse the repository at this point in the history
- Env files are in binder directory
- notebooks are in the root directory

Close #2
  • Loading branch information
pierrepo committed Jun 26, 2020
1 parent 8f0c165 commit 7541ce4
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Example repository to create an environment with course materials in Bash.

## Structure of the repo

This repository follows the [binder-examples/conda](https://github.com/binder-examples/conda) example very closely.
This repository is based on the [binder-examples/conda](https://github.com/binder-examples/conda) example.

[`repo2docker`](https://repo2docker.readthedocs.io) is the underlying tool that is used to build an environment from a repository.

`repo2docker` can be configured with several types of files. In the case of this repo:

- `environment.yml`: specify dependencies that will be installed using `conda`
- `apt.txt`: specify dependencies that will be installed using `apt`
- `postBuild`: specify extra dependencies such as JupyterLab extensions and activate the [Bash kernel](https://github.com/takluyver/bash_kernel)
- `binder/environment.yml`: specify dependencies that will be installed using `conda`
- `binder/apt.txt`: specify dependencies that will be installed using `apt`
- `binder/postBuild`: specify extra dependencies such as JupyterLab extensions and activate the [Bash kernel](https://github.com/takluyver/bash_kernel)

Once created, the environment can be reused without building it again.

Expand All @@ -31,4 +31,4 @@ Materials can be added anywhere to this repository, either at the top level or i

When building the environment, the materials (and any other file) will be copied to the Docker image.

In this example, there is already a test notebook available under `materials/example.ipynb`.
In this example, there is a test notebook available `example.ipynb`.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 7541ce4

Please sign in to comment.