Docs for installing `tracy` on non-Windows platforms are lacking

Open Beginner friendly
#8,366 5 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
linux, ubuntu
Domain
documentation

Research direction

Start with Bevy’s existing Tracy usage instructions and compare them with the reported Linux/Ubuntu setup steps. Use the Tracy capture/build/unix and profiler/build/unix paths and the listed build commands as the source material; done means the documentation explains the non-Windows setup and how to launch the profiler.

Written by the indexing model from the issue text.

Description

A-Diagnostics C-Docs O-Linux O-MacOS

How can Bevy's documentation be improved?

I just got this set up on PopOs (Linux, Ubuntu). I documented the steps I took and my confusion in this thread.

Key steps:

  1. Clone the tracy repo, and checkout the correct tag.
  2. Install pkg-config, glfw, freetype, capstone, dbus. Names may vary.
  3. cd into the capture/build/unix folder and run make release LEGACY=1 (legacy flag is for wayland support).
  4. Do the same for profiler/build/unix.
  5. Open the profiler folder in your CLI, then call ./Tracy-release.
  6. Follow existing instructions to actually use the GUI with Bevy.
Dominant language
Rust
Stars
48.3k
Forks
4.9k
Avg merge
3d 17h
Merged PRs (30d)
172

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bevyengine/bevy

All issues in bevyengine/bevy

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.