mirror of
https://github.com/NicolasBohn/NexQuant.git
synced 2026-08-05 19:17:43 +00:00
chore: Move config files to proper locations
Moved: - ATTRIBUTION.md → docs/ - .bandit.yml → constraints/ - data_config.yaml → constraints/ Removed: - selector.log (generated log file) Root directory: 29 files → 26 files (only essentials)
This commit is contained in:
@@ -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.
|
||||
Reference in New Issue
Block a user