Metadata-Version: 2.4
Name: makereadme
Version: 0.0.2
Summary: A simple CLI tool to generate README.md files from Python scripts
Author: Glayton Ricardo
License: MIT License
        
        Copyright (c) 2025 Glayton Ricardo
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
        and associated documentation files (the "Software"), to deal in the Software without restriction, 
        including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
        and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
        subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies 
        or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
        INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 
        PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE 
        FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
        ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project-URL: Homepage, https://github.com/GR-MARTINS/mkreadme
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE-PT
Dynamic: license-file

# mkreadme

**mkreadme** is a simple CLI tool to generate README.md files from Python scripts.

---
## Installation

```bash
pip install mkreadme
```
---

## Usage 
```bash
mkreadme your_script.py
```
---

## 📄 LICENSE (MIT - inglês)


---

## 📄 LICENSE-PT (tradução)



---

## 📄 tests/test_basic.py
```python
````
