Files-Readme

SourceForge supports using README files to document a particular folder within your project. The contents of the README file will be displayed below the folder's file listing in SourceForge's beta file browser. You can provide installation instructions, notes about which packages to download, etc, to help your users as they download your project's files.

Usage

Simply add a file with "readme" (case doesn't matter) in the name into the folder you wish to document, using either the web UI or our FTP/SCP/rsync support.

Note that after uploading, there is usually a short delay before the readme can be shown.

Supported Formats

We currently support any files with “README” in the name (case doesn't matter) that end in the following extensions:

  • Plain text: .txt
  • Markdown: .md, .mkd, .mkdn, .mdown, .markdown
  • Textile: .textile
  • Creole: .creole
  • ReST: .rst, .rest, .rst.txt, .rest.txt

Any other text README files are displayed as plain text, just like a README.txt file. Binary (PDF, Word documents) and HTML files are not displayed, though a link to download them is provided.

Raw HTML

Raw HTML is not supported, even in the formats (e.g., Markdown) that allow its use. Any raw HTML will be escaped.

Inheritance

If a subfolder doesn't have its own README file, it will inherit the closest README in its parent folders.

Multiple READMEs

When multiple READMEs are in the same folder, the newest file will be displayed.