# bfg9000

**bfg9000** (*"build file generator"*) is a cross-platform *build configuration
system* with an emphasis on making it easy to define how to build your software.
It converts a Python-based build script into the appropriate files for your
underlying build system of choice.

## A brief example

You can't get much simpler than the simplest `build.bfg` file:

```python
executable('simple', files=['simple.cpp'])
```

To build this executable, we need to create the actual build files and then
run them:

```sh
$ bfg9000 path/to/src/ build/
$ cd build
$ ninja
```

From there, you can run your newly-created executable: `./simple`. Hooray!

For further examples, please see the
[`examples/`](https://github.com/jimporter/bfg9000/tree/master/examples)
subdirectory.

## Installation

bfg9000 uses [setuptools](http://pythonhosted.org/setuptools/), so installation
is much the same as any other Python package. Just run:

```sh
$ python setup.py install
```

From there, you can start using bfg to build your software!

!!! note
    Since many users don't need it, MSBuild support is an optional feature.
    To install all the dependencies required for MSBuild, you can run:

    ```
    $ pip install -e .[msbuild]
    ```

# bfg9000

**bfg9000** (*"build file generator"*) is a cross-platform *build configuration
system* with an emphasis on making it easy to define how to build your software.
It converts a Python-based build script into the appropriate files for your
underlying build system of choice.

## A brief example

You can't get much simpler than the simplest `build.bfg` file:

```python
executable('simple', files=['simple.cpp'])
```

To build this executable, we need to create the actual build files and then
run them:

```sh
$ bfg9000 path/to/src/ build/
$ cd build
$ ninja
```

From there, you can run your newly-created executable: `./simple`. Hooray!

For further examples, please see the
[`examples/`](https://github.com/jimporter/bfg9000/tree/master/examples)
subdirectory.

## Installation

bfg9000 uses [setuptools](http://pythonhosted.org/setuptools/), so installation
is much the same as any other Python package. Just run:

```sh
$ python setup.py install
```

From there, you can start using bfg to build your software!

!!! note
    Since many users don't need it, MSBuild support is an optional feature.
    To install all the dependencies required for MSBuild, you can run:

    ```
    $ pip install .[msbuild]
    ```

Fix docs for installing with MSBuild support
Fix docs for installing with MSBuild support
