README.md

Textpattern CMS

A flexible, elegant, fast and easy-to-use content management system written in PHP. Textpattern is free and open source software.

• System requirements
• Download Textpattern
• Install Textpattern
• Upgrade Textpattern
• Help and Support
• Development
• Contributing
• Thank you
• Legal

System requirements

Textpattern is installed to a web server with PHP and MySQL.

Ensure the server meets or exceeds the system requirements before you continue.

Download Textpattern

The current production release is version 4.7.3. It can be downloaded from the Textpattern website or GitHub in .zip and .tar.gz varieties.

If you want to use the multi-site functionality in Textpattern, get the .tar.gz archive.

	textpattern.com	GitHub
.zip	Download	Download
.tar.gz	Download	Download

Install Textpattern

Please see README.txt for details on installing Textpattern.

Upgrade Textpattern

Please see README.txt for details on upgrading Textpattern.

Help and Support

The Textpattern support forum is home to a friendly and helpful community of Textpattern users and experts. Textpattern also has a social network presence on Twitter.

Development

The development version can be obtained from the Textpattern repository on GitHub. Note that development versions are works-in-progress and not recommended for use on live production servers.

Anticipated changes to future system requirements

System requirements for the development version may differ from the production release system requirements.

As a development version approaches release, minimum and recommended system requirements are confirmed and the production release system requirements is updated accordingly.

The following table outlines anticipated forthcoming changes to system requirements for future releases. It takes into account vendor support, security considerations, overall performance and other factors.

Note that minimum and/or recommended versions listed may change multiple times during the development process.

Textpattern development version

	Minimum	Recommended
PHP	5.5	vendor supported (7.2 or 7.3)
MySQL	—	vendor supported (typically 5.6, 5.7 or 8.0)
Apache	—	vendor supported (2.4)
Nginx	1.10	mainline (1.17) or stable (1.16)

Contributing

Do you want to help with the development of Textpattern CMS? Please refer to the contributing documentation for full details.

GitHub topic tags

If you use GitHub for Textpattern-related development please consider adding some of the following topic keywords to your public project repositories, so we can build a network of discoverable resources:

• textpattern
• textpattern-plugin
• textpattern-theme
• textpattern-website (for websites built with Textpattern)
• textpattern-development (for development resources)

Additional development tools

Various components used within Textpattern CMS (such as the bundled themes and language translations) are maintained in standalone repositories. Textpattern has a simple development toolset built on Node.js to pull the distribution files of those repositories into the core as required.

You can install Node.js using the installer or package manager.

Install required dev tools:

npm install

You can then pull the following components from the CLI, like so:

npm run get-default-theme
npm run get-classic-admin-theme
npm run get-hive-admin-theme
npm run get-pophelp
npm run get-textpacks
npm run get-dependencies

To request a specific tag or branch:

npm run get-default-theme 4.7.3
npm run get-classic-admin-theme 4.7.3
npm run get-classic-admin-theme 4.7.x
npm run get-hive-admin-theme 4.7.x
npm run get-textpacks 4.7.x

You can verify PHP code via a PHP linter from the CLI, like so:

npm run phplint

You can verify JavaScript code via a JavaScript linter from the CLI, like so:

npm run eslint

Release tools:

Usage: npm run txp-gitdist <version> [dest-dir] (dest-dir defaults to a temporary location).

npm run txp-index
npm run txp-checksums
npm run txp-gitdist 1.2.3 ../my-dest-dir

Thank You

We are grateful to DigitalOcean and BrowserStack for their kind considerations in supporting Textpattern CMS by way of web hosting infrastructure (DigitalOcean) and cross browser testing platform (BrowserStack). Thank you!

Legal

Released under the GNU General Public License. See LICENSE.txt for terms and conditions.

Includes contributions licensed under the GNU Lesser General Public License. See LICENSE-LESSER.txt for terms and conditions.

Includes contributions licensed under the New BSD License. See LICENSE-BSD-3.txt for terms and conditions.