| <!--- | |
| Licensed to the Apache Software Foundation (ASF) under one | |
| or more contributor license agreements. See the NOTICE file | |
| distributed with this work for additional information | |
| regarding copyright ownership. The ASF licenses this file | |
| to you under the Apache License, Version 2.0 (the | |
| "License"); you may not use this file except in compliance | |
| with the License. You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, | |
| software distributed under the License is distributed on an | |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| KIND, either express or implied. See the License for the | |
| specific language governing permissions and limitations | |
| under the License. | |
| --> | |
| # DataFusion Book | |
| This folder builds a DataFusion user guide using [mdBook](https://github.com/rust-lang/mdBook). | |
| ## Build and run book locally | |
| Build the latest files with `mdbook build`. | |
| Open the book locally by running `open book/index.html`. | |
| ## Install mdBook | |
| Download the `mdbook` binary or run `cargo install mdbook`. | |
| Then manually open it, so you have permissions to run it on your Mac. | |
| Add it to your path with a command like this so you can easily run the commands: `mv ~/Downloads/mdbook /Users/matthew.powers/.local/bin`. |