Skip to content

Commit 37752ac

Browse files
authored
Merge pull request #15 from ESMValGroup/dev_environment_file
Created an environment.yml file to facilitate making a local build of webserver
2 parents 522ccf2 + c9d8bac commit 37752ac

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ and submitting [bug reports][issues]
7171
about things that don't work, aren't clear, or are missing.
7272
If you are looking for ideas, please see the 'Issues' tab for
7373
a list of issues associated with this repository,
74-
or you may also look at the issues for [Data Carpentry][dc-issues],
74+
or you may also look at the issues for [Data Carpentry][dc-issues],
7575
[Software Carpentry][swc-issues], and [Library Carpentry][lc-issues] projects.
7676

7777
Comments on issues and reviews of pull requests are just as welcome:
@@ -130,17 +130,30 @@ Extensive instructions for building and viewing the pages locally can be found [
130130
```bash
131131
# apt (Ubuntu/Devian)
132132
sudo apt install ruby-dev ruby-bundler
133+
```
134+
or
135+
```bash
133136
# dnf (Fedora/Redhat)
134137
sudo dnf install rubygem-bundler ruby-devel
135-
to install the required ruby packages and
138+
```
139+
140+
Alternatively, there's an environment file available which can be installed in conda with:
141+
```bash
142+
conda env create -f environment.yml -n esmvaltool_tutorial
143+
```
144+
145+
To install the required ruby packages, run the following command in the tutorial's
146+
main directory to build and serve the website locally:
136147
```bash
137148
make serve
138149
```
139-
to build and serve the website locally. The output on the terminal will contain a line similar to
150+
151+
The output on the terminal will contain a line similar to:
140152
```
141153
Server address: http://127.0.0.1:4000
142154
```
143-
open the address in your browser to preview the website.
155+
This address can be opened in your browser to preview the website.
156+
144157

145158
## Other Resources
146159

environment.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
name: esmvaltool_tutorial
2+
channels:
3+
- conda-forge
4+
dependencies:
5+
- gxx_linux-64
6+
- rb-nokogiri
7+
- ruby

0 commit comments

Comments
 (0)