xref: /btstack/doc/manual/docs-template/quick_start.md (revision bb7587459f2fed5f4d3ce64395fde121598a8d99)
1503a627eSMilanka Ringwald#
2503a627eSMilanka Ringwald
3503a627eSMilanka Ringwald## General Tools
4503a627eSMilanka Ringwald
5503a627eSMilanka RingwaldMost ports use a regular Makefile to build the examples.
6503a627eSMilanka Ringwald
7503a627eSMilanka RingwaldOn Unix-based systems, git, make, and Python are usually installed. If
8503a627eSMilanka Ringwaldnot, use the system’s packet manager to install them.
9503a627eSMilanka Ringwald
10503a627eSMilanka RingwaldOn Windows, there is no packet manager, but it's easy to download and install all requires development packets quickly by hand. You'll need:
11503a627eSMilanka Ringwald
12503a627eSMilanka Ringwald- [Python](http://www.python.org/getit/) for Windows. When using the official installer, please confirm adding Python to the Windows Path.
13503a627eSMilanka Ringwald- [MSYS2](https://msys2.github.io) is used to provide the bash shell and most standard POSIX command line tools.
14503a627eSMilanka Ringwald- [MinGW64](https://mingw-w64.org/doku.php) GCC for Windows 64 & 32 bits incl. make. To install with MSYS2: pacman -S mingw-w64-x86_64-gcc
15503a627eSMilanka Ringwald- [git](https://git-scm.com) is used to download BTstack source code. To install with MSYS2: pacman -S git
16503a627eSMilanka Ringwald- [winpty](https://github.com/rprichard/winpty) a wrapper to allow for console input when running in MSYS2: To install with MSYS2: pacman -S winpty
17503a627eSMilanka Ringwald
18503a627eSMilanka Ringwald## Getting BTstack from GitHub
19503a627eSMilanka Ringwald
20503a627eSMilanka RingwaldUse git to clone the latest version:
21503a627eSMilanka Ringwald
22503a627eSMilanka Ringwald    git clone https://github.com/bluekitchen/btstack.git
23503a627eSMilanka Ringwald
24503a627eSMilanka RingwaldAlternatively, you can download it as a ZIP archive from
25503a627eSMilanka Ringwald[BTstack’s page](https://github.com/bluekitchen/btstack/archive/master.zip) on
26503a627eSMilanka RingwaldGitHub.
27503a627eSMilanka Ringwald
28503a627eSMilanka Ringwald## Let's Go
29503a627eSMilanka Ringwald
30503a627eSMilanka RingwaldThe easiest way to try BTstack is on a regular desktop setup like macOS, Linux or Windows together with a standard USB Bluetooth Controller. Running BTstack on desktop speeds up the development cycle a lot and also provides direct access to full packet log files in cases something doesn't work as expected. The same code can then later be run unmodified on an embedded target.
31503a627eSMilanka Ringwald
32*bb758745SMatthias RingwaldFor macOS and Linux, please see [libusb](../ports/existing_ports/#sec:libusbPort) port.
33*bb758745SMatthias RingwaldFor Windows, please see [windows-winusb](../ports/existing_ports/#sec:windows-winusbPort) port.
34503a627eSMilanka Ringwald
35*bb758745SMatthias RingwaldOr checkout the [list of existing ports](../ports/existing_ports)
36