Spaces:
Sleeping
Sleeping
File size: 4,383 Bytes
cb2979b |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# 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! 🎊**
|