Skip to content

OPEN_SOURCE.md

Latest commit

 

History

History
279 lines (204 loc) · 6.79 KB

OPEN_SOURCE.md

File metadata and controls

279 lines (204 loc) · 6.79 KB

Open Source Release

Welcome! 🎉

The Cap Table Simulator is now fully open sourced under the MIT License. This means the code is free for everyone to use, modify, and distribute.

What This Means

You Can:

✅ Use it - For personal, educational, or commercial projects ✅ Modify it - Change the code to suit your needs ✅ Distribute it - Share copies with others ✅ Sublicense it - Use it as part of your own projects ✅ Sell it - Use it commercially without restrictions

You Must:

📋 Include the license - Include a copy of the MIT License with your distribution 📋 Include attribution - Keep the copyright notice in the code

You Cannot:

❌ Hold the creators liable - The software is provided "as-is" ❌ Claim you created it - Be honest about the source

Getting Started as a Developer

For Using the Code

  1. Clone the repository
  2. Review the README.md for features and setup
  3. Follow CONTRIBUTING.md if you plan to contribute
  4. Check the LICENSE for detailed terms

For Contributing

  1. Read CONTRIBUTING.md for development guidelines
  2. Review CODE_OF_CONDUCT.md for community standards
  3. Fork and create a feature branch
  4. Submit pull requests with clear descriptions
  5. Participate in code reviews

For Using in Your Project

# Clone the repository
git clone https://github.com/yourusername/cap-table-simulator.git

# Install dependencies
npm install

# Start development
npm run dev

# Build for production
npm build

Then modify and use as needed for your project!

Project Structure & Key Files

Source Code

src/
├── App.tsx              Main application component
├── components/          17 React components
├── types.ts             TypeScript type definitions
└── index.tsx            Entry point

Configuration

├── package.json         Dependencies and metadata
├── tsconfig.json        TypeScript configuration
├── vite.config.ts       Build configuration
└── .gitignore           Git ignore rules

Documentation

├── README.md            Feature overview
├── CONTRIBUTING.md      Contribution guidelines
├── CODE_OF_CONDUCT.md   Community standards
├── LICENSE              MIT License
└── OPEN_SOURCE.md       This file

Community & Support

Getting Help

  • Documentation: Check README.md and specific feature docs
  • Issues: Open a GitHub issue for bugs or questions
  • Discussions: Participate in community discussions
  • Email: Contact maintainers for urgent matters

Contributing

  • Bug Fixes: Submit PRs with fixes
  • Features: Discuss before implementing major features
  • Documentation: Improve docs and examples
  • Testing: Help test and report issues

Community Values

  1. Respectful - Treat everyone with dignity
  2. Inclusive - Welcome all contributions
  3. Collaborative - Work together to improve
  4. Professional - Maintain high standards

MIT License Summary

The MIT License is one of the most permissive open source licenses available. Here's what you need to know:

Permissions ✅

  • Commercial use
  • Modification
  • Distribution
  • Private use

Conditions 📋

  • Include license and copyright notice

Limitations ❌

  • No warranty
  • No liability

For full details, see LICENSE

Commercial Use

Yes! You can use this in commercial projects. Just remember to:

  1. Include the MIT License
  2. Include the copyright notice
  3. Document any modifications you make
  4. Acknowledge the original source

Example Use Cases

  • SaaS Application: Add Cap Table Simulator as a feature
  • Consulting: Use as a tool for clients
  • Educational: Teach equity modeling
  • Personal: Use for your own startup
  • Library: Build upon it for other projects

Contributing Back

While not required, we'd love contributions! Options include:

Code Contributions

  • Bug fixes and improvements
  • New features (discuss first!)
  • Performance optimizations
  • Code quality improvements

Non-Code Contributions

  • Documentation improvements
  • Translation to other languages
  • Design improvements
  • Testing and bug reports
  • Community support

How to Contribute

  1. Check CONTRIBUTING.md for guidelines
  2. Fork the repository
  3. Create a feature branch
  4. Submit a pull request
  5. Participate in code review

Attribution

If you use this project, we appreciate (but don't require) attribution:

Suggested Attribution

Cap Table Simulator - MIT License
https://github.com/yourusername/cap-table-simulator

Designed for equity scenario modeling and partnership negotiations.

In Your README

This project uses [Cap Table Simulator](https://github.com/yourusername/cap-table-simulator)
licensed under the MIT License.

Future of the Project

Current Status

  • ✅ Phase 1 Complete (Accessibility & UX)
  • ✅ Phase 2 Complete (Advanced Analysis)
  • 📋 Phase 3 Planned (Comparison & Export)

Roadmap

  • Scenario comparison views
  • PDF/CSV export
  • Custom milestone input
  • Historical tracking
  • Team collaboration features
  • Advanced analytics

How to Help

  • Open issues for needed features
  • Submit PRs for improvements
  • Test beta features
  • Provide feedback

License & Legal

MIT License

This project is licensed under the MIT License. See LICENSE for full text.

Copyright

Copyright (c) 2024 Cap Table Simulator Contributors

No Warranty

The software is provided "as is" without warranty of any kind. Use at your own risk.

No Liability

The creators and contributors cannot be held liable for damages or losses from using this software.

Questions?

For Users

  • Check README.md for features and setup
  • Review documentation files
  • Open a GitHub issue

For Developers

For Contributors

Share Your Use Cases!

We'd love to hear how you're using Cap Table Simulator! Whether you're:

  • Using it for your startup
  • Building it into your product
  • Teaching with it
  • Improving it

Please share! Open an issue or discussion to tell us about your use case.

Thank You! 🙌

Thank you for being part of our open source community. Together, we're making equity modeling more accessible and transparent for everyone.

Happy coding! 🚀

Version: 0.2.0 License: MIT Status: Open Source Last Updated: November 10, 2024