# learn-nbdev


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

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 learn_nbdev in Development mode

``` sh
# make sure learn_nbdev package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to learn_nbdev
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/mettafore/learn-nbdev):

``` sh
$ pip install git+https://github.com/mettafore/learn-nbdev.git
```

or from [conda](https://anaconda.org/mettafore/learn-nbdev)

``` sh
$ conda install -c mettafore learn_nbdev
```

or from [pypi](https://pypi.org/project/learn-nbdev/)

``` sh
$ pip install learn_nbdev
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/mettafore/learn-nbdev)’s
[pages](https://mettafore.github.io/learn-nbdev/). Additionally you can
find package manager specific guidelines on
[conda](https://anaconda.org/mettafore/learn-nbdev) and
[pypi](https://pypi.org/project/learn-nbdev/) respectively.

## How to use

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

``` python
1+1
```

    2

``` python
from learn_nbdev.cool_lib import foo, go_duckies_yourself
```

``` python
go_duckies_yourself("morris")
```

    'go duckies yourself morris'

``` python
foo()
```

    foo
