https://github.com/hiyouga/papercode-readme-template

How to write a pretty readme for your paper's code.
https://github.com/hiyouga/papercode-readme-template

machine-learning paper research

Last synced: 6 months ago
JSON representation

How to write a pretty readme for your paper's code.

• Host: GitHub
• URL: https://github.com/hiyouga/papercode-readme-template
• Owner: hiyouga
• License: mit
• Created: 2021-04-23T08:57:03.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-04-29T10:40:43.000Z (over 4 years ago)
• Last Synced: 2025-02-14T11:33:49.131Z (8 months ago)
• Topics: machine-learning, paper, research
• Homepage:
• Size: 115 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Papercode-readme-template

This repository guides researchers in writing a pretty readme for their paper's code.

You can create your own `README` file using the given [template](Template.md), and here is an [example](Example.md) created by this template.

And remember to fill out the *description* and *website* of your repositories. It is also recommended to add some topics at the frontpage.

Feel free to contribute by creating issues or pulling requests.

### Todo

- [ ] An interactive WebUI to generate readme on the fly.

### Contact

hiyouga [AT] buaa [DOT] edu [DOT] cn