# nbdev-hello-world


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

I want to use `nbdev` for a project but I am not sure what type of
project I want to create yet.

This repo was create for the tutorial.

I had a *mostly* positive experience. There were a few [bumps in the
road](https://forums.fast.ai/t/nbdev-tests-fail-on-first-commit/115893/4)
but I made it.

## Developer Guide

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

### Install nbdev_hello_world in Development mode

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

# make changes under nbs/ directory
# ...

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

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/eitanlees/nbdev-hello-world):

``` sh
$ pip install git+https://github.com/eitanlees/nbdev-hello-world.git
```

or from [conda](https://anaconda.org/eitanlees/nbdev-hello-world)

``` sh
$ conda install -c eitanlees nbdev_hello_world
```

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

``` sh
$ pip install nbdev_hello_world
```

### Documentation

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

## How to use

``` python
say_hello('Eitan')
```

    'Hello Eitan!'