Skip to content

Commit 454fdb6

Browse files
committed
Updates README.md with makefile info #398
1 parent 87beac3 commit 454fdb6

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,40 @@
1+
# CDMS2
2+
13
### Builds
24
[![CircleCI](https://circleci.com/gh/CDAT/cdms.svg?style=svg)](https://circleci.com/gh/CDAT/cdms)
35
[![Coverage Status](https://coveralls.io/repos/github/CDAT/cdms/badge.svg)](https://coveralls.io/github/CDAT/cdms)
4-
[![TravisCI](https://travis-ci.org/CDAT/cdms.svg?branch=master)](https://travis-ci.org/CDAT/cdms/builds)
56
![platforms](http://img.shields.io/badge/platforms-linux%20|%20osx-lightgrey.svg)
67

78

89
### Anaconda
910
[![Anaconda-Server Badge](https://anaconda.org/uvcdat/cdms2/badges/version.svg)](https://anaconda.org/uvcdat/cdms2)
1011
[![Anaconda-Server Badge](https://anaconda.org/uvcdat/cdms2/badges/downloads.svg)](https://anaconda.org/uvcdat/cdms2)
1112
[![Anaconda-Server Badge](https://anaconda.org/uvcdat/cdms2/badges/installer/conda.svg)](https://conda.anaconda.org/uvcdat)
13+
14+
# Building conda package
15+
16+
```bash
17+
make dev-build
18+
```
19+
20+
## Build in docker container
21+
```bash
22+
make dev-docker
23+
```
24+
25+
# Makefile targets
26+
27+
- **conda-info**: Runs `conda info` in the test environment.
28+
- **conda-list**: Runs `conda list` in the test environment.
29+
- **dev-docker**: Builds dev environment in a docker container.
30+
- **dev-docker-run**: Will run docker container.
31+
- **dev-environment**: Will create dev environment using local conda.
32+
- **dev-install**: Builds and installs CDMS2 in dev environment. Run this after making any code changes.
33+
- **setup-build**: Clones CDAT/conda-recipes into workdir.
34+
- **setup-tests**: Creates test environment using local conda.
35+
- **conda-rerender**: Rerenders conda recipe using conda smithy.
36+
- **conda-build**: Builds conda recipe.
37+
- **conda-upload**: Uploads conda build artifacts.
38+
- **conda-dump-env**: Dumps test environment using `conda list --explicit`, this generates a file with the specific files installed.
39+
- **run-tests**: Runs units tests in test environment.
40+
- **run-coveralls**: Runs coverage in test environment.

0 commit comments

Comments
 (0)