Skip to content

Update getting started/ fix nix shell #113

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
TobTheRock merged 3 commits into from
Sep 2, 2025
Merged

Update getting started/ fix nix shell #113

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
adcafdb
chore: fix nix shell
TobTheRock Sep 2, 2025
337d1f1
docs: adapt to CLI with repo path
TobTheRock Sep 2, 2025
b49cd9a
docs: fix whitespace
TobTheRock Sep 2, 2025
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
7 changes: 4 additions & 3 deletions docs/introduction/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ it into a directory that is included in the `$PATH` environment variable or buil

## Run debug-flow

Run `debug-flow` inside the Git Repository that should be managed using:
Run `debug-flow` using:

```sh
debug-flow serve
debug-flow <git-repo>
```

This will create a `./debug-flow` directory and start a webserver on `localhost` that provides access
where `<git-repo> is the Git Repository that should be managed (default:`.`)
This will create a `./debug-flow`directory and start a webserver on`localhost` that provides access
to your projects and the repository.

The host and port that the server binds to is printed in the terminal and can then be opened in the
Expand Down
1 change: 1 addition & 0 deletions shell.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ pkgs.mkShell {
export OPENSSL_DIR=${pkgs.openssl.dev}
export OPENSSL_LIB_DIR=${pkgs.openssl.out}/lib
export OPENSSL_INCLUDE_DIR=${pkgs.openssl.dev}/include
export LD_LIBRARY_PATH=${pkgs.openssl.out}/lib:$LD_LIBRARY_PATH
'';
}
Loading