diff --git a/ATTRIBUTION.md b/ATTRIBUTION.md new file mode 100644 index 00000000..e010da21 --- /dev/null +++ b/ATTRIBUTION.md @@ -0,0 +1,101 @@ +# Attribution Guidelines + +## Using Predix in Your Project + +If you use code, concepts, or ideas from this project, you **must**: + +### 1. Keep the MIT License + +Include the full MIT License text in your project's LICENSE file or documentation. + +### 2. Include Copyright Notice + +``` +Copyright (c) 2025 Predix Team +Original Project: https://github.com/TPTBusiness/Predix +``` + +### 3. Provide Attribution + +Add a notice in your documentation or README: + +```markdown +## Acknowledgments + +This project uses code/concepts from [Predix](https://github.com/TPTBusiness/Predix), +licensed under the [MIT License](https://opensource.org/licenses/MIT). +``` + +### 4. State Changes + +If you modified the code: + +```markdown +## Modifications + +Based on Predix (original by Predix Team). +Modified by [Your Name/Organization] on [Date]. +Changes: [Brief description of changes] +``` + +--- + +## What You CAN Do + +✅ Use in commercial projects +✅ Modify the code +✅ Distribute copies +✅ Use in proprietary software +✅ Sell products that include this code + +## What You CANNOT Do + +❌ Remove copyright notice +❌ Remove license text +❌ Claim you wrote the original code +❌ Hold the authors liable + +--- + +## Example Attribution + +**Good Example:** +```markdown +# My Trading Project + +This project uses factor generation concepts from [Predix](https://github.com/TPTBusiness/Predix). + +## License +MIT License - see LICENSE file for details. + +## Credits +- Original Predix code by Predix Team (MIT License) +- Modified by John Doe, 2025 +``` + +**Bad Example (Copyright Violation):** +```markdown +# My Trading Project + +All code written by John Doe. +All rights reserved. No copying allowed. +``` + +--- + +## Legal Basis + +This requirement comes from the MIT License itself: + +> "The above copyright notice and this permission notice shall be included +> in all copies or substantial portions of the Software." + +Failure to comply means your license to use this code is automatically terminated. + +--- + +## Questions? + +If you're unsure about attribution requirements, please open an issue or contact us. + +We want our code to be used and appreciated, but proper attribution is essential. diff --git a/README.md b/README.md index 5275fa46..37be1a19 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ PyPI CI Ruff + Stars

--- @@ -276,6 +277,15 @@ Core dependencies (see [`requirements.txt`](requirements.txt) for full list): This project is licensed under the **MIT License** – see the [`LICENSE`](LICENSE) file for details. +### Attribution Requirements + +If you use this code or concepts in your project, you **must**: +1. Include the MIT License text +2. Keep the copyright notice: "Copyright (c) 2025 Predix Team" +3. Provide attribution to the original project + +See [`ATTRIBUTION.md`](ATTRIBUTION.md) for detailed guidelines and examples. + --- ## Contributing