Skip to content

Commit e849e8c

Browse files
authored
Merge pull request #1 from Compaile/readme-changes
Readme changes
2 parents d2a7db0 + 6b38656 commit e849e8c

File tree

1 file changed

+8
-18
lines changed

1 file changed

+8
-18
lines changed

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CTRACK
1+
# CTRACK ![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
22

33
An open-source benchmark and tracking library for C++ projects, designed to provide deep insights into function performance with minimal overhead.
44

@@ -27,7 +27,7 @@ CTRACK is a powerful tool that can be seamlessly integrated into both developmen
2727

2828
## Basic Usage
2929

30-
CTRACK is designed to be simple to use while providing powerful performance insights. Here's how to get started:
30+
CTRACK is easy to use and provides powerful performance insights. Here's how to get started:
3131

3232
1. To track a function, simply add the `CTRACK;` macro at the beginning of the function body:
3333

@@ -198,8 +198,6 @@ Choose the installation method that best fits your project's needs and structure
198198

199199
## Advanced Usage
200200

201-
CTRACK offers various advanced features and customization options for more complex scenarios and specific requirements.
202-
203201
### Customizing Output Settings
204202

205203
You can fine-tune CTRACK's output using the `ctrack_result_settings` struct:
@@ -295,13 +293,18 @@ While there are several excellent benchmarking and profiling tools available, CT
295293

296294
9. **Instant Bottleneck Detection**: CTRACK's unique "time active" and "time active exclusive" metrics allow developers to instantly spot bottlenecks, even in complex multithreaded codebases. This feature sets CTRACK apart from other tools that struggle to provide clear insights in concurrent environments.
297295

298-
CTRACK combines the ease of use of manual timing with the robustness of professional benchmarking tools, all in a package that's production-ready and highly adaptable. Its ability to quickly identify performance issues in multithreaded scenarios makes it an invaluable tool for modern C++ development.
296+
CTRACK combines the ease of use of manual timing with the robustness of professional benchmarking tools, all in a package that's production-ready and highly adaptable. Its ability to quickly identify performance issues in multithreaded scenarios makes useful tool for modern C++ development.
299297

300298

301299
## Contributing
302300

303301
We welcome and encourage contributions from the community! Your input helps make CTRACK better for everyone. Here's how you can contribute:
304302

303+
### Roadmap
304+
- [ ] JSON Export Support
305+
- [ ] SQL Export Support
306+
- [ ] Handling Complex Circular
307+
305308
### Pull Requests
306309
We're always excited to receive pull requests that improve CTRACK. When submitting a PR, please ensure:
307310

@@ -318,20 +321,7 @@ Found a bug? We want to hear about it! Please open an issue on our GitHub reposi
318321
### Feature Requests
319322
Have an idea for a new feature? Feel free to open an issue to discuss it. We're always looking for ways to make CTRACK more useful.
320323

321-
### License Compliance
322-
All contributions to CTRACK must be compliant with the MIT License. By submitting a pull request, you are agreeing to license your contributions under the same MIT License that covers the CTRACK project.
323-
324-
We appreciate your efforts to make CTRACK better. Thank you for your contributions!
325-
326324
## License
327325

328326
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
329327

330-
331-
## Contact
332-
333-
COMPAILE Solutions GmbH
334-
Gritznerstraße 7
335-
76227 Karlsruhe
336-
337-

0 commit comments

Comments
 (0)