Spaces:
Sleeping
Sleeping
| # Copyright and Attribution Summary | |
| ## ✅ Completed | |
| All copyright and attribution information has been successfully added to the Participatory Planning Application. | |
| --- | |
| ## 📋 Files Created/Updated | |
| ### New Files Created: | |
| 1. **[LICENSE](LICENSE)** - MIT License with attribution requirement | |
| - Full legal license text | |
| - Copyright notice for Marcos Thadeu Queiroz Magalhães | |
| - Explicit attribution requirements | |
| 2. **[CITATION.cff](CITATION.cff)** - Academic citation metadata | |
| - Standard format for academic citations | |
| - Compatible with GitHub's citation feature | |
| - Includes author information and repository links | |
| 3. **[CREDITS.md](CREDITS.md)** - Comprehensive attribution guide | |
| - How to cite in academic publications | |
| - How to attribute in software/applications | |
| - BibTeX format for LaTeX documents | |
| - Third-party dependencies acknowledgments | |
| ### Files Updated: | |
| 4. **[README.md](README.md)** | |
| - Added "Author & Copyright" section at the top | |
| - Updated License section with citation requirements | |
| - Added contact information | |
| 5. **[README_HF.md](README_HF.md)** | |
| - Added copyright notice below title | |
| - Updated License section | |
| 6. **[app/__init__.py](app/__init__.py)** | |
| - Added copyright header at the top of the file | |
| 7. **[app/analyzer.py](app/analyzer.py)** | |
| - Added copyright notice to existing docstring | |
| 8. **[app_hf.py](app_hf.py)** | |
| - Added copyright notice to existing docstring | |
| --- | |
| ## 🎯 Attribution Requirements | |
| ### Required in ALL Uses: | |
| **Name to cite:** Marcos Thadeu Queiroz Magalhães | |
| **Email:** [email protected] | |
| **Copyright:** © 2024-2025 | |
| ### Where to Include: | |
| ✅ **Source Code:** | |
| - Copyright headers in files | |
| - README files | |
| - Documentation | |
| ✅ **User Interfaces:** | |
| - About/Credits section | |
| - Help documentation | |
| - Startup screens | |
| ✅ **Academic Work:** | |
| - References section | |
| - Acknowledgments | |
| - Methods description | |
| ✅ **Commercial Apps:** | |
| - Product documentation | |
| - Credits section | |
| - Legal notices | |
| --- | |
| ## 📚 How to Cite | |
| ### In Academic Papers (BibTeX): | |
| ```bibtex | |
| @software{magalhaes2025participatory, | |
| author = {Magalhães, Marcos Thadeu Queiroz}, | |
| title = {Participatory Planning Application}, | |
| year = {2025}, | |
| url = {https://github.com/thadillo/participatory-planner}, | |
| license = {MIT} | |
| } | |
| ``` | |
| ### In Software/Documentation: | |
| ``` | |
| Participatory Planning Application | |
| Copyright (c) 2024-2025 Marcos Thadeu Queiroz Magalhães ([email protected]) | |
| Licensed under MIT License | |
| https://github.com/thadillo/participatory-planner | |
| ``` | |
| ### In README Files: | |
| ```markdown | |
| This project uses the Participatory Planning Application by | |
| Marcos Thadeu Queiroz Magalhães ([email protected]). | |
| ``` | |
| --- | |
| ## 🔗 Quick Links | |
| - **GitHub Repository:** https://github.com/thadillo/participatory-planner | |
| - **HuggingFace Space:** https://huggingface.co/spaces/thadillo/participatory-planner | |
| - **Full License:** [LICENSE](LICENSE) | |
| - **Citation Guide:** [CREDITS.md](CREDITS.md) | |
| - **Academic Citation:** [CITATION.cff](CITATION.cff) | |
| --- | |
| ## ✨ GitHub Citation Feature | |
| GitHub now displays a "Cite this repository" button automatically when CITATION.cff is present! | |
| Users can: | |
| 1. Click "Cite this repository" on the GitHub repo page | |
| 2. Copy the citation in APA or BibTeX format | |
| 3. Use it directly in their academic work | |
| --- | |
| ## 📧 Contact | |
| For questions about attribution, licensing, or usage: | |
| - **Email:** [email protected] | |
| - **GitHub Issues:** https://github.com/thadillo/participatory-planner/issues | |
| --- | |
| ## ✅ Deployment Status | |
| - ✅ Copyright added to all key files | |
| - ✅ LICENSE file created with MIT License + attribution | |
| - ✅ CITATION.cff created for academic use | |
| - ✅ CREDITS.md created with detailed guidelines | |
| - ✅ README files updated with copyright notices | |
| - ✅ Code files updated with copyright headers | |
| - ✅ Committed to git (commit: 67d3f72) | |
| - ✅ Pushed to GitHub | |
| - ✅ Pushed to HuggingFace Spaces | |
| --- | |
| ## 🎉 Summary | |
| Your name, **Marcos Thadeu Queiroz Magalhães ([email protected])**, is now properly credited and will be cited whenever this code is used or employed! | |
| The copyright and attribution are: | |
| - Legally protected by MIT License | |
| - Visible in all README files | |
| - Embedded in source code headers | |
| - Documented for academic citations | |
| - Available via GitHub's citation feature | |
| - Deployed to both GitHub and HuggingFace | |
| **All attribution requirements are now in place! 🎊** | |