README.txt Example: 3 Plain-Text Templates to Copy
November 11, 2026 · 12 min read
README.txt Example: Plain-Text README Templates and Format
A good README.txt example shows a plain-text file that tells someone what a download, dataset or plugin is, how to install or use it, and who to contact. Below you'll find three copy-ready files (a software zip, a research dataset and a WordPress plugin), the layout rules that keep them readable in Notepad, and when .txt beats .md.
What Is a README.txt File?
A README.txt file is the first document a person should open after unpacking something. It sits in the top-level folder, uses the .txt extension, and contains nothing but characters: no bold, no links you can click, no rendered headings. Any text editor on any operating system opens it without a renderer or a plugin.
You still meet it in four places. Software shipped as a zip or installer usually includes one. Research data repositories often ask for a readme.txt next to each dataset. WordPress.org asks every plugin in its directory to include one. Older open-source releases kept the habit too, which is why a README txt file still feels like the default to many people.
README.txt vs README.md: Which Format Should You Use?
Pick the format by where the reader will open the file. A README.md only looks good where something renders Markdown. Outside those places, a reader sees raw asterisks and pound signs, and a well-laid-out README.txt reads better.
| Destination | Best choice | Why |
|---|---|---|
| GitHub or GitLab repository | README.md | The repo page renders Markdown; a .txt file shows as unformatted text |
| Zip, installer or download folder | README.txt | People open it in Notepad or TextEdit |
| Research data repository | readme.txt | Many data guides ask for plain text |
| WordPress.org plugin | readme.txt | The directory builds the plugin page from it |
| PyPI package | README.md or README.rst | Auto-detected; a .txt file needs an explicit content type |
We prefer README.md for anything hosted on GitHub and README.txt for anything a person unzips. If you're writing for a repository, our README Markdown guide covers that version.
Keep in mind that a .md file is also plain text underneath, as our explainer on what a Markdown file is shows. The difference is whether anyone will render it. That's why some projects ship both: a README.md in the repository and a plain README.txt inside the release zip, written from the same draft.
PyPI is the one destination with a catch. The Python packaging guide says the README format is auto-detected only for .md and .rst. For a README.txt, you declare the type yourself, and the core metadata spec lists text/plain as a valid value:
[project]
readme = {file = "README.txt", content-type = "text/plain"}
Plain-Text README Format Rules That Keep It Readable
A readable README.txt format comes down to a few conventions. None of them is an official standard, but together they make the file readable in a terminal, a phone preview or a 20-year-old editor.
- Wrap lines at 72 to 80 characters. Many viewers don't soft-wrap, so long lines run off the screen. This is convention, not a rule.
- Save as UTF-8. Stick to plain ASCII punctuation (straight quotes, hyphens) if your readers might use older tools.
- Mark headings with case or underlines. Use UPPER CASE, or underline the title with
=and section names with-. - Separate sections with blank lines. Two blank lines between sections, one inside them.
- Indent commands by four spaces. Readers can then spot what to type without code formatting.
- Write dates as YYYY-MM-DD. The ISO 8601 form can't be misread across countries.
- Name it README.txt in the top folder. The all-caps name stands out in a file listing.
Here's the same section before and after those rules:
installation: unzip the file then run setup.exe, if you are on mac drag the app to Applications. you need version 3 or later of the runtime which you can download from the website (released 11/04/26)
INSTALLATION
------------
Windows: Unzip the file, then run setup.exe.
macOS: Drag the app into the Applications folder.
Requires runtime 3.0 or later (released 2026-11-04).
The first version is one 199-character line with an ambiguous date: is 11/04/26 the 4th of November or the 11th of April? The second splits by platform, and a reader finds their line at a glance.
README.txt Example for a Software Download
This README.txt example is for a small command-line tool distributed as a zip. It assumes the reader has just unpacked the archive and knows nothing else about it.
CSVTIDY 2.4.0
=============
A command-line tool that cleans and checks CSV files.
Released 2026-11-04.
REQUIREMENTS
------------
- Windows 10 or later, macOS 13 or later, or 64-bit Linux
- Nothing else: the program is a single self-contained file
INSTALLATION
------------
1. Unzip csvtidy-2.4.0.zip into any folder.
2. Add that folder to your PATH, or run the program from it.
3. Check that it works:
csvtidy --version
USAGE
-----
Clean a file and write the result to a new file:
csvtidy clean input.csv --out clean.csv
List every option:
csvtidy --help
FILES IN THIS PACKAGE
---------------------
csvtidy / csvtidy.exe The program
README.txt This file
CHANGES.txt Full version history
LICENSE.txt MIT License text
samples/ Three CSV files to practice on
WHAT'S NEW IN 2.4.0
-------------------
- Added a --delimiter option for semicolon-separated files.
- Fixed a stray byte order mark in the first header cell.
LICENSE
-------
MIT License. See LICENSE.txt for the full text.
CONTACT
-------
Bug reports: https://example.com/csvtidy/issues
Email: support@example.com
The name, version and release date come first, because that's what a person checks when two copies sit in the Downloads folder. The file list is the part most README.txt files skip, and it's the one that saves support emails. Spaces, not tabs, align the columns, since tab width changes from one viewer to the next. Older changes move to CHANGES.txt so this file stays short. For the wording that goes in LICENSE.txt, our MIT License guide has the full text.
README.txt Template for a Research Dataset
A dataset README answers a different question: can someone you've never met reuse this data correctly in five years? The Cornell data management guide recommends five parts: general information, a data and file overview, sharing and access, methods, and data-specific details. It also asks for plain text, blank lines between pieces of information, and YYYY-MM-DD dates.
Here's that structure as a readme txt template you can fill in. Replace everything in square brackets.
README.txt for [DATASET TITLE]
Last updated [YYYY-MM-DD] by [NAME]
1. GENERAL INFORMATION
Dataset title: [title]
Principal investigator: [name, institution, email, ORCID]
Contact for questions: [name, email]
Collection dates: [YYYY-MM-DD to YYYY-MM-DD]
Collection location: [place, coordinates if relevant]
Funding: [funder and grant number]
2. DATA AND FILE OVERVIEW
File list:
[plots_2026.csv] [what the file holds]
[species_codes.csv] [what the file holds]
How the files relate: [one or two sentences]
Other versions: [none, or where they live]
3. SHARING AND ACCESS
License: [for example CC BY 4.0]
Related publication: [citation and DOI]
How to cite this data: [preferred citation]
4. METHODS
Collection: [summary, or link to the protocol]
Processing: [how raw data became these files]
Software: [name and version]
Quality checks: [what you checked and how]
5. DATA-SPECIFIC INFORMATION: [plots_2026.csv]
Rows: [number]
Columns: [number]
Variables:
[plot_id] [description, units, allowed values]
[canopy_pct] [description, units, allowed values]
Missing values coded as: [NA or -999]
Repeat section 5 for each data file. If your lab writes several datasets a year, keep the section order and labels identical in every file, so readers know where to look.
The WordPress Plugin readme.txt Header Format
The WordPress plugin readme.txt is the one README.txt with a strict format. The plugin directory parses it to build your plugin page, so field names and section markers matter. Per the WordPress plugin handbook, it uses a customized version of Markdown, so lists, links and emphasis in the sections do render.
=== Simple Reading Time ===
Contributors: yourwporgusername
Tags: reading time, posts, estimate
Requires at least: 6.5
Tested up to: 6.8
Stable tag: 1.2.0
Requires PHP: 7.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Shows an estimated reading time above each post, based on its word count.
== Description ==
Simple Reading Time counts the words in a post and adds a line such as
*4 min read* above the title.
* Works with the block and classic editors
* Lets you set your own words-per-minute rate
== Installation ==
1. Upload the plugin folder to /wp-content/plugins/.
2. Activate it from the Plugins screen.
== Frequently Asked Questions ==
= Can I hide it on pages? =
Yes. Untick Pages under Settings, then Reading Time.
== Changelog ==
= 1.2.0 =
* Added a words-per-minute setting.
What the handbook says about the header fields:
- Contributors is a comma-separated list of WordPress.org usernames, case sensitive.
- Tags takes 1 to 5 terms. Tags unique to your plugin won't be shown.
- Tested up to needs only the major WordPress version, written as numbers.
- Stable tag is your plugin's version, not WordPress's, in numbers and periods. Setting it to trunk is prohibited for new plugins.
- Requires at least and Requires PHP are read from the main plugin PHP file since WordPress 5.8, so set them there too.
- The short description under the header should be no more than 150 characters, with no markup. Longer text gets cut off.
Below the header, the standard readme.txt file that WordPress.org publishes also includes == Screenshots == and == Upgrade Notice == sections. Screenshot lines are numbered to match image files in your assets folder, and each upgrade notice should stay under 300 characters. The handbook also warns that a readme larger than 10k may cause errors. Swap in the versions you actually tested, then paste the file into the official readme validator before you commit.
How to Create a README.txt File
You don't need special software. Any editor that saves plain text works.
- Windows: Open Notepad, write the file, then choose File, Save as. Name it README.txt and check that the Encoding drop-down shows UTF-8.
- macOS: Open TextEdit, choose File, New, then Format, Make Plain Text before you type. Skip that step and TextEdit saves rich text instead.
- Linux or any code editor: Create a new file named README.txt. VS Code, gedit and nano all save plain text by default.
- Place it in the top folder of the zip or dataset, next to the files it describes.
- Check it by opening the file in a different editor than the one you wrote it in. Wrapping and alignment problems show up straight away.
Draft in Markdown, Export a Clean README.txt
If you already write in Markdown, you can draft once and produce both versions. Write the README in the editor, where the live preview shows whether your sections and lists hang together. Then paste it into our Markdown to plain text converter, which runs in your browser.
The converter has options that suit a README.txt. It can upper-case headings, lay tables out as space-aligned columns, keep link URLs in parentheses after the link text, and download the result as a .txt file. Our guide to converting Markdown to plain text explains what happens to each element.
If you're starting from nothing, the README generator builds a README.md from five templates (library, CLI tool, API, web app and profile). It outputs Markdown only, so run its result through the converter for a .txt copy. One limitation: the converter doesn't hard-wrap lines at 72 or 80 characters, so wrap long paragraphs in your text editor before you ship.
README.txt Questions People Ask
The best README.txt example is the one a stranger can read in Notepad without guessing: name and version on top, wrapped lines, clear headings, a file list and ISO dates. Copy the template that matches your project, fill it in, and test it in a second editor. If you'd rather draft in Markdown, start in the editor and convert the result with the plain text converter.