This document is the canonical source of truth for building and contributing to the [<!-- TODO: PROJECT_NAME --/>][project].
Please submit an [issue] on GitHub if you:
- Notice a requirement that this doc does not capture.
- Find a different doc that specifies requirements (the doc should instead link here).
Where needed, each piece of required software will have separate instructions for Linux, Windows, or macOS.
Parts of this project assume you are using GNU command line tools; you will need to install those tools on your system. Follow these directions to install the tools.
In particular, this command installs the necessary packages:
brew install coreutils ed findutils gawk gnu-sed gnu-tar grep make jqYou will want to include this block or something similar at the end of your .bashrc or shell init script:
GNUBINS="$(find `brew --prefix`/opt -type d -follow -name gnubin -print)"
for bindir in ${GNUBINS[@]}
do
export PATH=$bindir:$PATH
done
export PATHThis ensures that the GNU tools are found first in your path. Note that shell init scripts work a little differently for macOS. This article can help you figure out what changes to make.
If you are running Windows, you will need to use one of two methods to set up your machine. To figure out which method is the best choice, you will first need to determine which version of Windows you are running. To do this, press Windows logo key + R, type winver, and click OK. You may also enter the ver command at the Windows Command Prompt.
- If you're using Windows 10, Version 2004, Build 19041 or higher, you can use Windows Subsystem for Linux (WSL) to perform various tasks. Follow these instructions to install WSL2.
- If you're using an earlier version of Windows, then create a Linux virtual machine with at least 8GB of memory and 60GB of disk space.
Once you have finished setting up your WSL2 installation or Linux VM, follow the instructions below to configure your system for building and developing code.
After setting up your operating system, you will be required to install software dependencies required to run examples, perform static checks, linters, execute tests, etc.
Some of the build tools were installed when you prepared your system with the GNU command line tools earlier. However, you will also need to install the Command Line Tools for Xcode.
All Linux distributions have the GNU tools available. The most popular distributions and commands used to install these tools are below.
-
Debian/Ubuntu
sudo apt update sudo apt install build-essential
-
Fedora/RHEL/CentOS
sudo yum update sudo yum groupinstall "Development Tools" -
OpenSUSE
sudo zypper update sudo zypper install -t pattern devel_C_C++
-
Arch
sudo pacman -Sy base-devel
Some aspects of development require Docker. To install Docker in your development environment, follow the instructions from the Docker website.
Note: If you are running macOS, make sure that /usr/local/bin is in your PATH.
Once you have the basics, you can download and install any project specific dependencies by navigating to the root your fork and running:
make ensure-depsIf you have not forked and git clone'ed your fork, please review the next section.
To check out code to work on, please refer to [this guide][github_workflow].
Attribution: This was in part barrowed from this document but tailored for our use case.
[project]: https://github.com/deepgram/<!-- TODO: PROJECT_REPO_NAME --/> [issue]: https://github.com/deepgram/<!-- TODO: PROJECT_REPO_NAME --/>/issues [github_workflow]: https://github.com/deepgram/<!-- TODO: PROJECT_REPO_NAME --/>/.github/GITHUB_WORKFLOW.md