README

Welcome to the Polylang repository on GitHub. Here you can browse the source, discuss open issues and keep track of the development.

If you are not a developer, we recommend to download Polylang from WordPress directory.

Pre-requisites

Before starting, make sure that you have the following software installed and working on your computer:

1. A local WordPress (6.5 or later) instance
2. Git to clone the Polylang repository (or your fork of the Polylang repository).
3. Node.js which provides NPM. They are both required by Webpack that Polylang uses to build and minify CSS and javascript files. We recommend to install Node.js LTS version.
4. Composer because Polylang uses its autoloader to work and it is required to install development tools such as PHP CodeSniffer that ensures your code follows coding standards.

How to set up Polylang

The simplest way is to clone locally this repository and build it directly in your local WordPress instance by following the steps below:

1. Go to your local WordPress instance wp-content/plugins/ folder:
   cd your/local/wordpress/path/wp-content/plugins
2. Clone there the polylang repository (or your fork) from GitHub:
   git clone https://github.com/polylang/polylang.git
3. Go to your local Polylang clone folder from there: cd polylang
4. Run the composer command: composer build
5. Activate Polylang as if you had installed it from WordPress.org:
   See https://wordpress.org/plugins/polylang/#installation

Note: we recommend for Windows users to use Git Bash provided with Git for Windows instead of the command or powershell terminal.