diff --git a/README.md b/README.md index f84267e..905a73a 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,7 @@ These options should be considered carefully when setting up the project. They m - `folder_name`: Set the name of development folder. - `github_repo_group`: The name for the parent organization of the github repository. This typically is either the author's github name (e.g `n-wbrown`) or the organization that owns the github repository. - `import_name`: The name to use when importing this package in python. Defaults to the folder name. +- `strip_ipynb_outputs`: Selecting yes includes a hook to remove output from juypter notebooks before committing. Selecting "yes" is strongly recommended. See this [section](#committing-jupyter-notebook-output) for more details. #### Additional Options These options are less critical and can be easily configured at a later time. For those in a hurry or those who may be unsure what all these options do, the defaults will be sufficient for most use cases. @@ -80,7 +81,7 @@ These options are less critical and can be easily configured at a later time. Fo - `git_remote_name`: Set the name of git remote. (See `git remote` [documentation](https://git-scm.com/docs/git-remote) for details) - `readme_format`: Choose the format of the readme file to use. - `simple`: Simple omits most CI tools and additional organization folders. -- `strip_ipynb_outputs`: Selecting yes includes a hook to remove output from juypter notebooks before committing. Selecting "no" is strongly recommended. See this [section](#committing-jupyter-notebook-output) for more details. + Once the package has been configured via the questionnaire. Your new package will be created in a new directory matching the `folder_name` option.