README.md

ProjectTemplate-Python

English | 简体中文   GitHub | Gitee码云

File Modification

1. Setup pre-commit hook
   1. If necessary, modify .pre-commit-config.yaml
   2. In the repository root path, run

   pre-commit install

2. Modify the .gitignore file
3. Modify the LICENSE file This repository uses the MIT license, you may change it to other licenses
4. Modify the setup files
   1. setup.cfg
   2. setup.py, especially the basicsr keyword
5. Modify the requirements.txt files
6. Modify the VERSION file

GitHub Workflows

1. pylint
2. gitee-repo-mirror - Support Gitee码云
   1. Clone GitHub repo in the Gitee website
   2. Modify gitee-repo-mirror
   3. In Github Settings -> Secrets, add SSH_PRIVATE_KEY

Other Procedures

1. The description, website, topics in the main page
2. Support Chinese documents, for example, README_CN.md

Emoji

Emoji cheat-sheet

Emoji	Meaning
🚀	Used for BasicSR Logo
✨	Features
⚡	HOWTOs
🔧	Installation / Usage
⏳	TODO list
🐢	Dataset preparation
💻	Commands
🏰	Model zoo
📝	Designs
📜	License and acknowledgement
🌏	Citations
📧	Contact
Ⓜ️	Models
⏬	Download
📁	Datasets
📈	Curves
👀	Screenshot
📚	References

Useful Image Links

Google Colab Logo
Windows Logo
Ubuntu Logo

Other Useful Tips

1. More drop-down menu
   More

   • Nov 19, 2020. Set up ProjectTemplate-Python.