Welcome to the Substance repository! This library enhances your experience with Rust's cargo-bloat tool and provides additional features to optimize your projects.
To get started with Substance, download the latest release from our Releases page. After downloading, follow the instructions to execute the library and integrate it into your Rust projects.
Cargo-Bloat Integration: Analyze your binary size and identify unnecessary dependencies. - Enhanced Reporting: Get detailed reports on your project's size and composition.
- Customizable Options: Tailor the analysis to meet your specific needs.
- Cross-Platform Support: Works seamlessly on Windows, macOS, and Linux.
To install Substance, you can use Cargo, Rust's package manager. Open your terminal and run:
cargo install substanceThis command will fetch the latest version of Substance and install it on your system.
Once installed, you can start using Substance in your Rust projects. Here’s a simple command to analyze your project:
substance analyzeThis command will generate a report on your project's size and dependencies. You can customize the analysis with various flags:
substance analyze --output-format jsonThis command will output the report in JSON format, making it easy to integrate with other tools.
Here’s a basic example of how to use Substance in a project:
-
Create a new Rust project:
cargo new my_project cd my_project -
Add Substance as a dependency in your
Cargo.toml:[dependencies] substance = "0.1.0"
-
Use Substance in your code:
fn main() { // Your code here substance::analyze(); }
-
Run your project:
cargo run
This will execute the analysis and display the results in your terminal.
Substance provides detailed reports that help you understand your project's dependencies and size. The reports include:
- Total Size: The total size of your binary.
- Dependency Breakdown: A list of dependencies and their sizes.
- Unused Dependencies: Identify libraries that are not being used in your project.
We welcome contributions! If you want to help improve Substance, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or fix.
- Make your changes.
- Submit a pull request.
Please ensure that your code adheres to our coding standards and includes appropriate tests.
Substance is licensed under the MIT License. See the LICENSE file for more details.
If you have any questions or suggestions, feel free to reach out via the Issues section of this repository or contact us directly.
Thanks to the Rust community for their support and contributions. Your feedback helps us improve Substance and make it a better tool for everyone.
For more detailed documentation, visit our Wiki. Here, you will find guides, FAQs, and advanced usage scenarios.
We have exciting plans for the future of Substance! Here are some features we aim to implement:
- Web Interface: A user-friendly web interface for analyzing projects.
- Integration with CI/CD: Tools to automatically analyze projects in continuous integration pipelines.
- Advanced Metrics: More detailed metrics on dependency usage and optimization suggestions.
Please open an issue in the GitHub repository with detailed information about the bug, including steps to reproduce it.
Yes, Substance is designed to be stable and reliable for production use. However, always test it in your environment before deploying.
You can support us by contributing code, reporting issues, or sharing Substance with your network.
We take security seriously. If you discover a vulnerability, please report it to us immediately so we can address it.
Join our community to share ideas, ask questions, and collaborate with other users of Substance. You can find us on Discord or Reddit.
We plan to expand Substance with more features and improvements. Stay tuned for updates!
Thank you for visiting the Substance repository. We hope you find this library helpful for your Rust projects! For the latest updates, remember to check the Releases section.