MicroRepository/README.md

3 KiB

MicroRepository 📚

A template that gathers the minimal structure of my repository.

🚀 Features

  • Modern README
  • Multiple licenses: Apache 2.0 and SUSHI-WARE

🎯 Usage

A guide to using this repository template:

  1. Click Use this template > Create a new repository in the top right corner.
  2. Clone the created repository, rename README.example.md to README.md, edit it with your preferred editor, and migrate.
mv README.example.md README.md

# For Linux users
sed -i 's;HidemaruOwO/MyRepository;USERNAME/REPONAME;g' README.md

# For macOS users
sed -i '' 's;HidemaruOwO/MyRepository;USERNAME/REPONAME;g' README.md
  1. Edit credits in LICENSE and licenses/SUSHI-WARE.txt.

Important

If you don't change the credit in the license file, I will usually own the rights to your software. (LoL)

🌍 For contributer

By contributing to this project, you agree to the following terms:

  1. You grant a license: You grant the project owner a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to use, modify, distribute, and sublicense your contributions under the Apache License 2.0.
  2. You retain ownership: You still own the copyright of your contribution, but you waive any claims against the project related to your contribution.
  3. No additional patent rights: You do not grant additional patent rights beyond what is covered by Apache 2.0.
  4. Your contributions are original: You confirm that your contributions do not violate any third-party rights.

By submitting a pull request, you agree to these terms.

📜 License

This project is dual-licensed under Apache License 2.0 and SUSHI-WARE LICENSE.

A reference to the latest license should be used, even if the attached license is outdated of major versions.

🤝 Reference

This repository was created using the MicroRepository template.