Fix CI/CD: Add Gitea Actions workflow and fix linting issues
Some checks failed
CI / test (push) Failing after 13s
Some checks failed
CI / test (push) Failing after 13s
This commit is contained in:
75
tests/fixtures/README_EXAMPLE.md
vendored
Normal file
75
tests/fixtures/README_EXAMPLE.md
vendored
Normal file
@@ -0,0 +1,75 @@
|
||||
# Example Generated README
|
||||
|
||||
This is an example of a README file that can be generated by Auto README Generator CLI.
|
||||
|
||||
## Overview
|
||||
|
||||
A Python project located at `/example/project` containing multiple files.
|
||||
|
||||
## Supported Languages
|
||||
|
||||
This project uses:
|
||||
- **Python**
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
|
||||
- `requests` v2.31.0
|
||||
- `click` v8.0.0
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```python
|
||||
from project_name import main
|
||||
main()
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- Test suite included
|
||||
- Uses 2 dependencies
|
||||
- Contains 1 classes
|
||||
- Contains 3 functions
|
||||
|
||||
## API Reference
|
||||
|
||||
### `hello()`
|
||||
|
||||
Say hello.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
### `add(a, b)`
|
||||
|
||||
Add two numbers.
|
||||
|
||||
**Parameters:** `a, b`
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
||||
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
||||
4. Push to the branch (`git push origin feature/amazing-feature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
For Python development:
|
||||
- Run tests with `pytest`
|
||||
- Format code with `black` and `isort`
|
||||
- Check types with `mypy`
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
---
|
||||
|
||||
*Generated by Auto README Generator on 2024-01-15*
|
||||
Reference in New Issue
Block a user