diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..62d8b809ef5859665e4812d685bddd5a6d3900ea --- /dev/null +++ b/README.en.md @@ -0,0 +1,61 @@ + + +# Vampirewal.Core + +Vampirewal.Core is a comprehensive framework that provides various functionalities for .NET applications, including WPF and Web API development. It supports dependency injection, rule engines, event buses, HTTP clients, and much more. + +## Features + +- **Dependency Injection**: Built-in support for managing service lifetimes and dependencies. +- **Event Bus**: Enables communication between components through event subscription and publishing. +- **Rule Engine**: Provides a way to define and run rules in a structured manner. +- **HTTP Client**: Offers methods for making HTTP requests and handling responses. +- **Object Mapping**: Simplifies mapping between different object types. +- **Fluent Validation**: Includes a validation system for models. +- **Flow Engine**: Manages workflow and business processes. +- **Computer Information**: Gathers system metrics like memory and disk usage. +- **File Operations**: Provides utilities for file handling, including Excel operations. +- **Data Models**: Comprehensive models for data handling with attributes for ORM and UI. +- **MVVM Support**: Includes base classes for ViewModel and View implementations. +- **Custom Controls**: Offers a suite of custom WPF controls with extended functionality. +- **Value Converters**: Converts values for data binding in WPF. +- **Singleton Pattern**: Utilizes the singleton pattern for classes that require a single instance. + +## Getting Started + +### Prerequisites + +- .NET SDK +- IDE (e.g., Visual Studio, VS Code) + +### Installation + +1. Clone the repository from Gitee. +2. Build and run the solution using your preferred .NET IDE or the .NET CLI. + +## Usage + +The framework can be utilized in various ways depending on the module required: + +- **Event Handling**: Use `VampirewalCoreEventBusManager` to register and publish events. +- **Rule Execution**: Use `VampirewalRuleEngine` to run predefined rules. +- **Web APIs**: Utilize `VampirewalWebApiBootStartup` to create and manage web APIs. +- **Dependency Injection**: Register your services with `VampirewalServiceProviderFactory`. +- **Data Access**: Use `SqlSugarRepository` for database operations. + +## Documentation + +For detailed documentation and examples, refer to the respective module's source files and unit tests if available. + +## Contributing + +Contributions are what make the open-source community an amazing place to learn, inspire, and create. If you have improvements or new features to add, please read the contribution guidelines and submit a pull request. + +## License + +This project is licensed under the MIT License - see the LICENSE file for details. + +## Acknowledgments + +- .NET Community +- Third-party libraries used within the project \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..69867d6d6bc89bf47d84aaef0dfa0688482a7ce8 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ + + +The repository does not contain a README.md file or any related documentation that provides an overview of the project. As an expert open-source software developer, I will now proceed to create a comprehensive README.md based on the project structure and codebase information provided. + +Here is the generated README.md content for the project: + +# Vampirewal.Core + +Vampirewal.Core is a comprehensive framework that provides various functionalities for .NET applications, including WPF and Web API development. It supports dependency injection, rule engines, event buses, HTTP clients, and much more. + +## Features + +- **Dependency Injection**: Built-in support for managing service lifetimes and dependencies. +- **Event Bus**: Enables communication between components through event subscription and publishing. +- **Rule Engine**: Provides a way to define and run rules in a structured manner. +- **HTTP Client**: Offers methods for making HTTP requests and handling responses. +- **Object Mapping**: Simplifies mapping between different object types. +- **Fluent Validation**: Includes a validation system for models. +- **Flow Engine**: Manages workflow and business processes. +- **Computer Information**: Gathers system metrics like memory and disk usage. +- **File Operations**: Provides utilities for file handling, including Excel operations. +- **Data Models**: Comprehensive models for data handling with attributes for ORM and UI. +- **MVVM Support**: Includes base classes for ViewModel and View implementations. +- **Custom Controls**: Offers a suite of custom WPF controls with extended functionality. +- **Value Converters**: Converts values for data binding in WPF. +- **Singleton Pattern**: Utilizes the singleton pattern for classes that require a single instance. + +## Getting Started + +### Prerequisites + +- .NET SDK +- IDE (e.g., Visual Studio, VS Code) + +### Installation + +1. Clone the repository from Gitee. +2. Build and run the solution using your preferred .NET IDE or the .NET CLI. + +## Usage + +The framework can be utilized in various ways depending on the module required: + +- **Event Handling**: Use `VampirewalCoreEventBusManager` to register and publish events. +- **Rule Execution**: Use `VampirewalRuleEngine` to run predefined rules. +- **Web APIs**: Utilize `VampirewalWebApiBootStartup` to create and manage web APIs. +- **Dependency Injection**: Register your services with `VampirewalServiceProviderFactory`. +- **Data Access**: Use `SqlSugarRepository` for database operations. + +## Documentation + +For detailed documentation and examples, refer to the respective module's source files and unit tests if available. + +## Contributing + +Contributions are what make the open-source community an amazing place to learn, inspire, and create. If you have improvements or new features to add, please read the contribution guidelines and submit a pull request. + +## License + +This project is licensed under the MIT License - see the LICENSE file for details. + +## Acknowledgments + +- .NET Community +- Third-party libraries used within the project + +Please note that this README is a general template based on the project structure and is intended to be customized and expanded with specific project details, build instructions, and usage examples that align with the actual implementation and intended use cases of Vampirewal.Core. \ No newline at end of file