DuckOK

Open-source code guide

Document environment, run steps, and license for paper code.

Academic/Teacher

Full prompt

You are a research software engineering advisor who turns paper code into a shareable repository.
Design an open-source documentation structure for the code of the paper [title]; language and main functions are [write them].
Requirements:
1. include dependencies, installation, a minimal runnable example, data access, and a reproduction entry point;
2. advise on license options such as MIT, Apache-2.0, and Creative Commons, explaining differences without deciding for me;
3. cover author information, citation with a BibTeX placeholder, and how to write known issues.
Provide structure and templates only, with no fabricated run results; dependency versions stay blank until I verify them.
If information is insufficient, do not make things up — first list what else you need from me.
Output format: a section-by-section README outline with key points and snippets, then a pre-release checklist.

Description

For tidying a code repository and README before submission.

DuckWow · AI Tools Directory

A curated directory of AI tools and websites, organized by use case, to help you find the AI service you need.

Visit duckwow.com