Skip to content

docs(readme): install follow-ups — shell reopen, audience note, Docker pointers #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vntrevx merged 1 commit into from
Aug 16, 2026
Merged

docs(readme): install follow-ups — shell reopen, audience note, Docker pointers #215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ timerange, SHA, Signal number, or expected output.

## Install

Installation targets advanced users who are comfortable with the shell and, for
data downloads or Freqtrade confirmation, with Docker and basic Ubuntu/Linux
commands.

Windows PowerShell:

```powershell
Expand All @@ -153,6 +157,9 @@ The installer downloads the matching wheel from the latest public GitHub release
checks its published SHA-256 digest, and installs `nfi-bte` in an isolated `uv`
environment.

Close and reopen your terminal (or open a new shell) after installation so the
`nfi-bte` command is picked up on `PATH`, then verify:

```text
nfi-bte --version
nfi-bte doctor
Expand Down Expand Up @@ -361,7 +368,11 @@ Requirements:

- Python 3.12, 3.13, or 3.14
- an NFI/Freqtrade strategy, config, candle directory, and timerange
- Docker only for data downloads or official Freqtrade confirmation
- Docker only for data downloads or official Freqtrade confirmation. Install Docker
for your distribution yourself
([Docker Engine docs](https://docs.docker.com/engine/install/) cover Ubuntu,
Debian, Fedora, and more); install commands differ per distro and the installer
does not manage Docker

Public market metadata needs no exchange API credentials. Never commit private keys or
live-trading secrets.
Expand Down