From f1836e659f239da4cf3fc00d1f7c3b90372d9de9 Mon Sep 17 00:00:00 2001 From: Martin Turon Date: Sat, 30 Jul 2022 14:01:22 -0700 Subject: [PATCH 1/2] [docs] Add some getting started information to the top-level README. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 3370baf6..735e085e 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,25 @@ or see the documentation source under `docs/mkdocs/src`, or build the static HTM mkdocs build -f docs/mkdocs/mkdocs.yml ``` +## Usage + +### Getting Started + +For a quick start to using Bumble, see the [Getting Started](docs/mkdocs/src/getting_started.md) guide. + +### Dependencies + +To install package dependencies needed to run the bumble examples execute the following commands: + +``` +python -m pip install --upgrade pip +python -m pip install ".[test,development,documentation]" +``` + +### Examples + +Refer to the [Example Documentation](examples/README.md) for details on the included example scripts and how to run them. + ## License Licensed under the [Apache 2.0](LICENSE) License. From e6ee5ae9967ef70421260f1298e0cf27f5c41b86 Mon Sep 17 00:00:00 2001 From: Martin Turon Date: Sat, 30 Jul 2022 14:18:08 -0700 Subject: [PATCH 2/2] [docs] Add references to some of the docs to the top-level for discoverability. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 735e085e..7091ae00 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,10 @@ python -m pip install ".[test,development,documentation]" Refer to the [Example Documentation](examples/README.md) for details on the included example scripts and how to run them. +The complete [list of Examples](/docs/mkdocs/src/examples/index.md), and what they are designed to do is here. + +There are also a set of [Apps and Tools](docs/mkdocs/src/apps_and_tools/index.md) that show the utility of Bumble. + ## License Licensed under the [Apache 2.0](LICENSE) License.