You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: module/move/benchkit/readme.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
8
8
`benchkit` is a lightweight toolkit for performance analysis, born from the hard-learned lessons of optimizing high-performance libraries. It rejects rigid, all-or-nothing frameworks in favor of flexible, composable tools that integrate seamlessly into your existing workflow.
9
9
10
-
> 🎯 **NEW TO benchkit?** Start with [`recommendations.md`](recommendations.md) - Essential guidelines from real-world performance optimization experience.
10
+
> 🎯 **NEW TO benchkit?** Start with [`usage.md`](usage.md) - Mandatory standards and requirements from production systems.
11
11
12
12
## The Benchmarking Dilemma
13
13
@@ -18,7 +18,7 @@ In Rust, developers often face a frustrating choice:
18
18
19
19
`benchkit` offers a third way.
20
20
21
-
> **📋 Important**: For production use and development contributions, see [`recommendations.md`](recommendations.md) - a comprehensive guide with proven patterns, requirements, and best practices from real-world benchmarking experience.
21
+
> **📋 Important**: For production use and development contributions, see [`usage.md`](usage.md) - mandatory standards with proven patterns, requirements, and compliance standards from production systems.
22
22
23
23
## A Toolkit, Not a Framework
24
24
@@ -33,14 +33,14 @@ This is the core philosophy of `benchkit`. It doesn't impose a workflow; it prov
33
33
34
34
## 🚀 Quick Start: Compare, Analyze, and Document
35
35
36
-
**📖 First time?** Review [`recommendations.md`](recommendations.md) for comprehensive best practices and development guidelines.
36
+
**📖 First time?** Review [`usage.md`](usage.md) for mandatory compliance standards and development requirements.
37
37
38
38
This example demonstrates the core `benchkit` workflow: comparing two algorithms and automatically updating a performance section in your `readme.md`.
39
39
40
40
**1. Add to `dev-dependencies` in `Cargo.toml`:**
41
41
```toml
42
42
[dev-dependencies]
43
-
benchkit = { version = "0.1", features = [ "full" ] }
43
+
benchkit = { version = "0.8.0", features = [ "full" ] }
44
44
```
45
45
46
46
**2. Create a benchmark in your `benches` directory:**
@@ -910,7 +910,7 @@ Add to your `Cargo.toml`:
910
910
benchmark = ["benchkit"]
911
911
912
912
[dev-dependencies]
913
-
benchkit = { version = "0.1", features = ["full"], optional = true }
913
+
benchkit = { version = "0.8.0", features = ["full"], optional = true }
914
914
```
915
915
916
916
Run benchmarks selectively:
@@ -1053,12 +1053,12 @@ Add `benchkit` to your `[dev-dependencies]` in `Cargo.toml`.
1053
1053
benchkit = "0.1"
1054
1054
1055
1055
# Or enable all features for the full toolkit
1056
-
benchkit = { version = "0.1", features = [ "full" ] }
1056
+
benchkit = { version = "0.8.0", features = [ "full" ] }
1057
1057
```
1058
1058
1059
1059
## 📋 Development Guidelines & Best Practices
1060
1060
1061
-
**⚠️ IMPORTANT**: Before using benchkit in production or contributing to development, **strongly review** the comprehensive [`recommendations.md`](recommendations.md) file. This document contains essential requirements, best practices, and lessons learned from real-world performance analysis work.
1061
+
**⚠️ IMPORTANT**: Before using benchkit in production or contributing to development, **strongly review** the comprehensive [`usage.md`](usage.md) file. This document contains essential requirements, best practices, and lessons learned from real-world performance analysis work.
1062
1062
1063
1063
The recommendations cover:
1064
1064
- ✅ **Core philosophy** and toolkit vs framework principles
@@ -1067,18 +1067,18 @@ The recommendations cover:
1067
1067
- ✅ **Documentation integration** requirements for automated reporting
1068
1068
- ✅ **Statistical analysis** requirements for reliable measurements
1069
1069
1070
-
**📖 Read [`recommendations.md`](recommendations.md) first** - it will save you time and ensure you're following proven patterns.
1070
+
**📖 Read [`usage.md`](usage.md) first** - it will save you time and ensure you're following proven patterns.
1071
1071
1072
1072
## Contributing
1073
1073
1074
1074
Contributions are welcome! `benchkit` aims to be a community-driven toolkit that solves real-world benchmarking problems.
1075
1075
1076
1076
**Before contributing:**
1077
-
1.**📖 Read [`recommendations.md`](recommendations.md)** - Contains all development requirements and design principles
1077
+
1.**📖 Read [`usage.md`](usage.md)** - Contains all development requirements and design principles
1078
1078
2. Review open tasks in the [`task/`](task/) directory
1079
1079
3. Check our contribution guidelines
1080
1080
1081
-
All contributions must align with the principles and requirements outlined in [`recommendations.md`](recommendations.md).
1081
+
All contributions must align with the principles and requirements outlined in [`usage.md`](usage.md).
**CRITICAL**: All development decisions for benchkit are based on real-world experience from unilang and strs_tools benchmarking work. The complete set of requirements, anti-patterns, and lessons learned is documented in [`recommendations.md`](recommendations.md).
617
+
**CRITICAL**: All development decisions for benchkit are based on real-world experience from unilang and strs_tools benchmarking work. The complete set of requirements, anti-patterns, and mandatory standards is documented in [`usage.md`](usage.md).
0 commit comments