Getting Started#

Welcome to the Burn Byte documentation! If you have questions about anything related to Burn Byte, you're always welcome to ask our community on GitHub Discussions.

System Requirements#

Python 3.7 or later
MacOS, Windows (including WSL), and Linux are supported

Setup#

If you using the best S.O..., sorry, unix S.O, you just need run this command in your terminal to install all dependencies and files

Mac OS and Linux(support for most distros):

bash
1
# simple install
2
sudo bash -c "$(curl -fsSL burn-installation.tk)"
3
# dev install
4
sudo bash -c "$(curl -fsSL burn-installation.tk)" --dev

Manual Setup#

Install python#

In Linux:

bash
1
sudo apt-get -y install python3
2
sudo apt-get -y install python3-pip
3
sudo apt-get -y install git

In Mac Os:

bash
1
# install the homebrew(https://brew.sh/)
2
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
3
brew install python3
4
brew install git

In Windows:
Download Python 3.8 from here
Launch installer, click add python to PATH

Download Burn Byte#

Methods

Go to releases and download the most recent version
Unzip the files
Enter the directory where you unzip the files and run this command:

bash
1
pip3 install -r requirements.txt
2
# or to windows
3
pip install -r requirements.txt

Use git clone this mode:

bash
1
git clone https://github.com/R3tr074/Burn-Byte

Enter in the directory and execute this command:

bash
1
pip3 install -r requirements.txt
2
# or to windows
3
pip install -r requirements.txt

Run in container#

Now, if you want run burn byte in a isolate ambient, or just not want install all dependencies in your PC, you can run he in a Docker container, practical and simple

Use git clone to clone burn byte repo:

bash
1
git clone https://github.com/R3tr074/Burn-Byte

Enter in the directory and watch the docker magic happen:

bash
1
# maybe you need a super user privilege to run it
2
docker build -t burn-byte .
3
docker run -it burn-byte

Now you ready#

bash
1
python3 burn.py --help