nbdev_quickstart

quick start instructions for using nbdev

This file will become your README and also the index of your documentation.

Developer Guide

If you are new to using nbdev here are some useful pointers to get you started.

Install nbdev_quickstart in Development mode

# make sure nbdev_quickstart package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to nbdev_quickstart
$ nbdev_prepare

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/rhalldearn/nbdev_quickstart.git

or from conda

$ conda install -c rhalldearn nbdev_quickstart

or from pypi

$ pip install nbdev_quickstart

Documentation

Documentation can be found hosted on this GitHub repository’s pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.

How to use

Fill me in please! Don’t forget code examples:

1+1