mirror of
https://github.com/HidemaruOwO/MicroRepository.git
synced 2025-05-13 21:23:09 +09:00
📚 add README (README.md)
This commit is contained in:
parent
7e0d6fd3a1
commit
f9151d402e
1 changed files with 80 additions and 0 deletions
80
README.md
Normal file
80
README.md
Normal file
|
@ -0,0 +1,80 @@
|
||||||
|
# MicroRepository 📚
|
||||||
|
|
||||||
|
A template that gathers the minimal structure of my repository.
|
||||||
|
|
||||||
|
## 🚀 Features
|
||||||
|
|
||||||
|
- Modern README
|
||||||
|
- Multipull licenses: `Apache 2.0` and `SUSHI-WARE`
|
||||||
|
|
||||||
|
<!-- ## 🛠 Installation -->
|
||||||
|
|
||||||
|
<!-- ```bash -->
|
||||||
|
<!-- brew install micro-repository -->
|
||||||
|
<!-- ``` -->
|
||||||
|
|
||||||
|
<!-- ### 🏗 Build from Source -->
|
||||||
|
|
||||||
|
<!-- ```sh -->
|
||||||
|
<!-- git clone https://github.com/HidemaruOwO/MicroRepository.git -->
|
||||||
|
<!-- cd MicroRepository -->
|
||||||
|
|
||||||
|
<!-- make -j8 -->
|
||||||
|
|
||||||
|
<!-- install -Dm0755 -t "/usr/local/bin/" "dist/builded-binary" -->
|
||||||
|
<!-- ``` -->
|
||||||
|
|
||||||
|
<!-- - Arch Linux -->
|
||||||
|
|
||||||
|
<!-- ```sh -->
|
||||||
|
<!-- git clone https://github.com/HidemaruOwO/MicroRepository.git -->
|
||||||
|
<!-- cd MicroRepository -->
|
||||||
|
|
||||||
|
<!-- makepkg -si -->
|
||||||
|
<!-- ``` -->
|
||||||
|
|
||||||
|
## 🎯 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.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌍 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
|
||||||
|
|
||||||
|
<div align="left" >
|
||||||
|
|
||||||
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
|
||||||
|
[](https://github.com/MakeNowJust/sushi-ware)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
This project is dual-licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) and [SUSHI-WARE LICENSE](https://github.com/MakeNowJust/sushi-ware).
|
||||||
|
|
||||||
|
A reference to the latest license should be used, even if the attached license is outdated of major versions.
|
||||||
|
|
||||||
|
## 🤝 Reference
|
||||||
|
|
||||||
|
- [HidemaruOwO/MicroRepository](https://github.com/HidemaruOwO/MicroRepository)
|
Loading…
Add table
Reference in a new issue