Skip to content

Commit

Permalink
Update README and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjkuch committed Aug 12, 2024
1 parent b8f7d00 commit d3c6da1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@ The directory structure of your new project will look something like this (depen
└── plots.py <- Code to create visualizations
```

## Using unreleased changes

By default, `ccds` will download the most recently _released_ version of the template. If there are any _unreleased_ changes to the template (or changes in a separate branch) that you want to incorporate, you can do so by checking out whatever branch you'd like to use (checkout `master` for the latest changes):

```bash
ccds -c master
```

## Using v1

If you want to use the old v1 project template, you need to have either the cookiecutter-data-science package or cookiecutter package installed. Then, use either command-line program with the `-c v1` option:
Expand Down
10 changes: 9 additions & 1 deletion docs/docs/all-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,12 @@
CCDS provides a number of choices that you can use to customize your project. The defaults work well for many projects, but lots of tooling choices are supported. Here are the options for tools that you can use:


<!-- configuration-table.py output -->
<!-- configuration-table.py output -->

## Checking out other branches / using unreleased changes to the template

By default, `ccds` will download the most recently _released_ version of the template. If there are any _unreleased_ changes to the template (or changes in a separate branch) that you want to incorporate, you can do so by checking out whatever branch you'd like to use (checkout `master` for the latest changes):

```bash
ccds -c master
```

0 comments on commit d3c6da1

Please sign in to comment.