diff --git a/README.md b/README.md index 37c4e1f7d..c85e74725 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ ## Matrix.org Website -If you want to contribute to the website, make sure the problem you're trying to -fix or the feature you want to implement has been discussed in our issue tracker -and that we are interested in reviewing and merging such a contribution. +# Table of Contents +- [Overview](#overview) +- [Building the Website](#building-the-website) +- [Contribution Guidelines](#contribution-guidelines) +- [Contact Us](#contact-us) -To discuss maintenance of this site, please come talk to the team in -[#matrix.org-website:matrix.org](https://matrix.to/#/#matrix.org-website:matrix.org). +# Overview + +Matrix.org is a decentralized, open standard for real-time communication which allows users to collaborate in public and private rooms over IP. Matrix's purpose is to allow users to text and call without thinking about what app or phone the other user has. -## Building the website -Install the latest version of [Zola](https://www.getzola.org), clone the repo, and from the root of the -repo type +## Building the website +To contribute or run the website locally, follow the instructions below: +1. ''' +git clone https://github.com/matrix-org/matrix.org.git +cd matrix.org +''' +2. Ensure Zola is installed, otherwise install the latest version of [Zola](https://www.getzola.org) +From the root repo run the following command ``` zola serve ``` @@ -19,3 +27,25 @@ zola serve Zola will build the website and start a web server, usually at http://127.0.0.1:1111 +3. To build the website for production, run the command: +''' +zola build +''' + +## Contribution Guidelines +1. Fork the reposity (https://github.com/matrix-org/matrix.org.git) +2. Clone your fork to your local computer +3. Create a new branch and implement changes using +''' +git checkout -b +4. Submit a pull request (PR) + + +# Contact Us + +## Community +If you have any questions about the project or your contribution, you may join the various community chats on https://matrix.to/#/#matrix.org-website:matrix.org + +Before contributing, make sure the feature or bug you intend to address has already been discussed in our issue tracker +and that we are interested in reviewing and merging such a contribution. +