Update getting_started.md

Update README.md
Merge pull request #3 from google/gbg/usb-serial-number
2022-06-04 23:03:31 -07:00 · 2022-06-04 22:57:14 -07:00 · 2022-06-04 20:47:18 -07:00 · 2022-06-02 15:24:45 -07:00 · 2022-05-19 12:55:07 -07:00 · 2022-05-19 18:26:02 +00:00
4 changed files with 14 additions and 6 deletions
--- a/.github/workflows/python-build-test.yml
+++ b/.github/workflows/python-build-test.yml
@@ -24,11 +24,11 @@ jobs:
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
-        python -m pip install build
-        pip install ".[test]"
-    - name: Build package
-      run: |
-        python -m build
+        python -m pip install ".[test,development,documentation]"
    - name: Test with pytest
      run: |
        pytest
+    - name: Build
+      run: |
+        inv build
+        inv mkdocs
--- a/README.md
+++ b/README.md
@@ -11,6 +11,8 @@ Bluetooth Stack for Apps, Emulation, Test and Experimentation

 <img src="docs/mkdocs/src/images/logo_framed.png" alt="drawing" width="200" height="200"/>

+Bumble is a full-featured Bluetooth stack written entirely in Python. It supports most of the common Bluetooth Low Energy (BLE) and Bluetooth Classic (BR/EDR) protocols and profiles, including GAP, L2CAP, ATT, GATT, SMP, SDP, RFCOMM, HFP, HID and A2DP. The stack can be used with physical radios via HCI over USB, UART, or the Linux VHCI, as well as virtual radios, including the virtual Bluetooth support of the Android emulator.
+
 ## Documentation

 Browse the pre-built [Online Documentation](https://google.github.io/bumble/), 
--- a/docs/mkdocs/src/getting_started.md
+++ b/docs/mkdocs/src/getting_started.md
@@ -98,4 +98,9 @@ $ PYTHONPATH=. python examples/run_advertiser.py examples/device1.json serial:/d
 # Where To Go Next
 Once you've installed or downloaded Bumble, you can either start using some of the 
 [Bundled apps and tools](apps_and_tools/index.md), or look at the [examples](examples/index.md)
-to get a feel for how to use the APIs, and start writing your own applications.
+to get a feel for how to use the APIs, and start writing your own applications.
+
+Depending on the use case you're interested in exploring, you may need to use a physical Bluetooth
+controller, like a USB dongle or a board with a Bluetooth radio. Visit the [Hardware page](hardware/index.md)
+for more information on using a physical radio, and/or the [Transports page](transports/index.md) for more 
+details on interfacing with either hardware modules or virtual controllers over various transports.
--- a/setup.cfg
+++ b/setup.cfg
@@ -36,6 +36,7 @@ install_requires =
    grpcio >= 1.46; platform_system!='Emscripten'
    libusb1 >= 2.0.1; platform_system!='Emscripten'
    prompt_toolkit >= 3.0.16; platform_system!='Emscripten'
+    protobuf >= 3.12.4
    pyee >= 8.2.2
    pyserial-asyncio >= 0.5; platform_system!='Emscripten'
    pyserial >= 3.5; platform_system!='Emscripten'
Author	SHA1	Message	Date
Gilles Boccon-Gibod	1af61e8af3	Update getting_started.md	2022-06-04 23:03:31 -07:00
Gilles Boccon-Gibod	e11119c565	Update README.md	2022-06-04 22:57:14 -07:00
Gilles Boccon-Gibod	b1a31564ef	Merge pull request #3 from google/gbg/usb-serial-number gbg/usb serial number	2022-06-04 20:47:18 -07:00
Gilles Boccon-Gibod	a9bd77e6ee	add build workflow	2022-06-02 15:24:45 -07:00
Gilles Boccon-Gibod	d6b426eeec	Merge pull request #2 from stefanst3000/fix-missing-dep setup.cfg: add protobuf dependency and update package_dir	2022-05-19 12:55:07 -07:00
Stefan Stanacar	884315ae00	setup.cfg: add protobuf dependenc Add protobuf to required dependencies, since is needed when using the android-emulator transport. Signed-off-by: Stefan Stanacar <stefanst@google.com>	2022-05-19 18:26:02 +00:00