Antonio Scandurra
4312c7d1e6
With this pull request, we're introducing a `ZED_MEASUREMENTS` variable which is used by the `measure` function to print to stderr how long it took to execute a given closure. This is used right now to measure frame time when a new frame is requested. This data can be plotted as a histogram via `script/histogram`. Here's a workflow I typically use: - Run `export ZED_MEASUREMENTS=1` - Checkout a commit that you want to measure the performance of - Run zed in release mode and use it for 5-10 seconds - Copy the printed measurements into a file, say `version-a` - Checkout another commit that you want to measure the performance of - Run zed in release mode and use it for 5-10 seconds - Copy the printed measurements into a file, say `version-b` - Run `script/histogram version-a version-b` (note that you can supply however many files you want) Release Notes: - N/A
🚧 TODO 🚧
- Add intro
- Add link to contributing guide
- Add barebones running zed from source instructions
- Link out to further dev docs
Zed
Welcome to Zed, a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
Developing Zed
Licensing
License information for third party dependencies must be correctly provided for CI to pass.
We use cargo-about to automatically comply with open source licenses. If CI is failing, check the following:
- Is it showing a
no license specifiederror for a crate you've created? If so, addpublish = falseunder[package]in your crate's Cargo.toml. - Is the error
failed to satisfy license requirementsfor a dependency? If so, first determine what license the project has and whether this system is sufficient to comply with this license's requirements. If you're unsure, ask a lawyer. Once you've verified that this system is acceptable add the license's SPDX identifier to theacceptedarray inscript/licenses/zed-licenses.toml. - Is
cargo-aboutunable to find the license for a dependency? If so, add a clarification field at the end ofscript/licenses/zed-licenses.toml, as specified in the cargo-about book.