diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..9ceb879486ec09a359750ca193edcccf23c7dcbe --- /dev/null +++ b/README.en.md @@ -0,0 +1,68 @@ + + +# Skyline Utility Project + +This repository is a simple Python-based utility project that provides functionalities for logging and terminal output formatting. + +## Project Structure + +- **Beautify/Colorama.py**: Provides terminal color output capabilities. +- **Log/Loguru.py**: Implements logging functionality using `loguru`. +- **LICENSE**: The open-source license used by the project. +- **.gitignore**: Configuration file for Git to specify ignored files. + +## Functional Modules + +### Colorama.py +Provides a function for colorized log output: +```python +def log(level, msg): + # Outputs log messages with color, where `level` defines the log level +``` + +### Loguru.py +Wraps the functionality of the `loguru` module to simplify logging operations. + +## Installation + +Make sure to install the following dependencies: + +```bash +pip install loguru colorama +``` + +## Usage Examples + +### Output Colored Logs +```python +from Beautify.Colorama import log + +log("INFO", "This is an info log") +log("ERROR", "This is an error log") +``` + +### Use Loguru for Logging +```python +from Log.Loguru import logger + +logger.info("This is an info log") +logger.error("This is an error log") +``` + +## Contributing + +We welcome contributions and suggestions! Please follow these steps: + +1. Fork the repository +2. Create a new branch (`git checkout -b feature/new-feature`) +3. Commit your changes (`git commit -m 'Add new feature'`) +4. Push the branch (`git push origin feature/new-feature`) +5. Submit a Pull Request + +## License + +This project is licensed under the MIT License. For details, please refer to the [LICENSE](LICENSE) file. + +--- + +This concludes the brief description and usage guide of the project. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cb38c5daa270af47d403f764f6248001ffd81923 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +The repository appears to be a simple Python-based utility project with modules for logging and output formatting. Here's a tailored README.md based on the project structure: + +--- + +# Skyline Utility Project + +这是一个简单的 Python 工具项目,提供日志记录和终端输出美化功能。 + +## 项目结构 + +- **Beautify/Colorama.py**: 提供终端颜色输出功能。 +- **Log/Loguru.py**: 使用 `loguru` 实现日志记录功能。 +- **LICENSE**: 项目使用的开源许可证。 +- **.gitignore**: Git 忽略文件配置。 + +## 功能模块 + +### Colorama.py +提供日志颜色化输出函数: +```python +def log(level, msg): + # 输出带有颜色的日志信息,level 定义日志级别 +``` + +### Loguru.py +封装了 `loguru` 模块的日志功能,用于更方便的日志记录。 + +## 安装依赖 + +确保安装以下依赖库: + +```bash +pip install loguru colorama +``` + +## 使用示例 + +### 输出彩色日志 +```python +from Beautify.Colorama import log + +log("INFO", "这是一条信息日志") +log("ERROR", "这是一条错误日志") +``` + +### 使用 Loguru 记录日志 +```python +from Log.Loguru import logger + +logger.info("这是一条信息日志") +logger.error("这是一条错误日志") +``` + +## 贡献指南 + +欢迎贡献代码或提出建议!请遵循以下步骤: + +1. Fork 仓库 +2. 创建新分支 (`git checkout -b feature/new-feature`) +3. 提交更改 (`git commit -m 'Add new feature'`) +4. 推送分支 (`git push origin feature/new-feature`) +5. 提交 Pull Request + +## 许可证 + +本项目使用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。 + +--- + +以上是项目的简要说明和使用指南。 \ No newline at end of file