From dcfddb844595e38cdd36f47eaa5d88a3f95a688c Mon Sep 17 00:00:00 2001 From: Matt Friedman Date: Thu, 1 Oct 2020 17:09:43 -0700 Subject: [PATCH 1/5] [ticket/16608] Modernize readme PHPBB3-16608 --- README.md | 53 ++++++++++--------- .../prosilver/theme/images/site_logo_blue.svg | 6 +++ 2 files changed, 34 insertions(+), 25 deletions(-) create mode 100644 phpBB/styles/prosilver/theme/images/site_logo_blue.svg diff --git a/README.md b/README.md index 92cd5b9867..c55584b750 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,45 @@ -[![phpBB](https://www.phpbb.com/theme/images/logos/blue/160x52.png)](http://www.phpbb.com) - -## ABOUT +[![phpBB](phpBB/styles/prosilver/theme/images/site_logo_blue.svg)](https://www.phpbb.com) phpBB is a free open-source bulletin board written in PHP. -## COMMUNITY +## 🧑🏻‍🤝🏻🧑🏽 Community -Get your copy of phpBB, find support and lots more on [phpBB.com](http://www.phpbb.com)! Discuss the development on [area51](http://area51.phpbb.com/phpBB/index.php). +Get your copy of phpBB, find support and lots more on [phpBB.com](https://www.phpbb.com)! Discuss the development on [area51](https://area51.phpbb.com/phpBB/index.php). -## INSTALLING DEPENDENCIES +## 👨‍💻 Contribute -To be able to run an installation from the repo (and not from a pre-built package) you need to run the following commands to install phpBB's dependencies. - - cd phpBB - php ../composer.phar install - - -## CONTRIBUTE - -1. [Create an account on phpBB.com](http://www.phpbb.com/community/ucp.php?mode=register) -2. [Create a ticket (unless there already is one)](http://tracker.phpbb.com/secure/CreateIssue!default.jspa) +1. [Create an account on phpBB.com](https://www.phpbb.com/community/ucp.php?mode=register) +2. [Create a ticket (unless there already is one)](https://tracker.phpbb.com/secure/CreateIssue!default.jspa) 3. Read our [Coding guidelines](https://area51.phpbb.com/docs/dev/development/coding_guidelines.html) and [Git Contribution Guidelines](https://area51.phpbb.com/docs/dev/development/git.html) 4. Send us a pull request -## VAGRANT +### 🏗️ Setting up a development build of phpBB -Read our [Vagrant documentation](phpBB/docs/vagrant.md) to find out how to use Vagrant to develop and contribute to phpBB. +To run an installation from the repo (and not from a pre-built package) on a local server, run the following commands: -## AUTOMATED TESTING +```bash +## Fork phpbb/phpbb to your GitHub account, then create a local clone of it: + +git clone git://github.com/your_github_name/phpbb.git + +## Install phpBB's dependencies (from the root of your phpbb repo): + +cd phpBB +php ../composer.phar install +``` + +Alternatively, you can read our [Vagrant documentation](phpBB/docs/vagrant.md) to find out how to use Vagrant to develop and contribute to phpBB. + +## 🔬 Automated Testing We have unit and functional tests in order to prevent regressions. You can view the bamboo continuous integration [here](https://bamboo.phpbb.com) or check our travis builds below: -Travis CI | AppVeyor | Branch | Description ----------- | -------- | ------- | ----------- -[![Build Status](https://travis-ci.org/phpbb/phpbb.svg?branch=master)](http://travis-ci.org/phpbb/phpbb) | [![Build status](https://ci.appveyor.com/api/projects/status/8g98ybngd2f3axy1/branch/master?svg=true)](https://ci.appveyor.com/project/phpBB/phpbb/branch/master) | **master** | Latest development version -[![Build Status](https://travis-ci.org/phpbb/phpbb.svg?branch=3.3.x)](http://travis-ci.org/phpbb/phpbb) | [![Build status](https://ci.appveyor.com/api/projects/status/8g98ybngd2f3axy1/branch/3.3.x?svg=true)](https://ci.appveyor.com/project/phpBB/phpbb/branch/3.3.x) | **3.3.x** | Development of version 3.3.x -[![Build Status](https://travis-ci.org/phpbb/phpbb.svg?branch=3.2.x)](http://travis-ci.org/phpbb/phpbb) | [![Build status](https://ci.appveyor.com/api/projects/status/8g98ybngd2f3axy1/branch/3.2.x?svg=true)](https://ci.appveyor.com/project/phpBB/phpbb/branch/3.2.x) | **3.2.x** | Development of version 3.2.x +Branch | Description | Travis CI | AppVeyor +------- | ----------- | ---------- | -------- +**master** | Latest development version | [![Build Status](https://travis-ci.org/phpbb/phpbb.svg?branch=master)](http://travis-ci.org/phpbb/phpbb) | [![Build status](https://ci.appveyor.com/api/projects/status/8g98ybngd2f3axy1/branch/master?svg=true)](https://ci.appveyor.com/project/phpBB/phpbb/branch/master) +**3.3.x** | Development of version 3.3.x | [![Build Status](https://travis-ci.org/phpbb/phpbb.svg?branch=3.3.x)](http://travis-ci.org/phpbb/phpbb) | [![Build status](https://ci.appveyor.com/api/projects/status/8g98ybngd2f3axy1/branch/3.3.x?svg=true)](https://ci.appveyor.com/project/phpBB/phpbb/branch/3.3.x) +**3.2.x** | Development of version 3.2.x | [![Build Status](https://travis-ci.org/phpbb/phpbb.svg?branch=3.2.x)](http://travis-ci.org/phpbb/phpbb) | [![Build status](https://ci.appveyor.com/api/projects/status/8g98ybngd2f3axy1/branch/3.2.x?svg=true)](https://ci.appveyor.com/project/phpBB/phpbb/branch/3.2.x) -## LICENSE +## 📜 License [GNU General Public License v2](http://opensource.org/licenses/gpl-2.0.php) diff --git a/phpBB/styles/prosilver/theme/images/site_logo_blue.svg b/phpBB/styles/prosilver/theme/images/site_logo_blue.svg new file mode 100644 index 0000000000..43de7ab3e4 --- /dev/null +++ b/phpBB/styles/prosilver/theme/images/site_logo_blue.svg @@ -0,0 +1,6 @@ + + + + + + From 358a5d8b4666a4fcedb7c2b2e745f094e8cf914a Mon Sep 17 00:00:00 2001 From: Matt Friedman Date: Thu, 1 Oct 2020 23:36:25 -0700 Subject: [PATCH 2/5] [ticket/16608] Adjust the blueness of the logo PHPBB3-16608 --- README.md | 2 +- phpBB/styles/prosilver/theme/images/site_logo_blue.svg | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c55584b750..87a58431e1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ phpBB is a free open-source bulletin board written in PHP. ## 🧑🏻‍🤝🏻🧑🏽 Community -Get your copy of phpBB, find support and lots more on [phpBB.com](https://www.phpbb.com)! Discuss the development on [area51](https://area51.phpbb.com/phpBB/index.php). +Get your copy of phpBB, find support and lots more on [phpBB.com](https://www.phpbb.com). Discuss the development on [area51](https://area51.phpbb.com/phpBB/index.php). ## 👨‍💻 Contribute diff --git a/phpBB/styles/prosilver/theme/images/site_logo_blue.svg b/phpBB/styles/prosilver/theme/images/site_logo_blue.svg index 43de7ab3e4..0fa38b9331 100644 --- a/phpBB/styles/prosilver/theme/images/site_logo_blue.svg +++ b/phpBB/styles/prosilver/theme/images/site_logo_blue.svg @@ -1,5 +1,5 @@ - + From dfdb92d3ab01d53833dba75805e0d3fc1605b2fb Mon Sep 17 00:00:00 2001 From: Matt Friedman Date: Fri, 2 Oct 2020 00:00:13 -0700 Subject: [PATCH 3/5] [ticket/16608] Update images again PHPBB3-16608 --- README.md | 2 +- phpBB/styles/all/imgs/svg/phpbb_logo.svg | 1264 +++++++++++++++++ .../prosilver/theme/images/site_logo_blue.svg | 6 - 3 files changed, 1265 insertions(+), 7 deletions(-) create mode 100644 phpBB/styles/all/imgs/svg/phpbb_logo.svg delete mode 100644 phpBB/styles/prosilver/theme/images/site_logo_blue.svg diff --git a/README.md b/README.md index 87a58431e1..f75f0be379 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![phpBB](phpBB/styles/prosilver/theme/images/site_logo_blue.svg)](https://www.phpbb.com) +[![phpBB](phpBB/styles/all/imgs/svg/phpbb_logo.svg)](https://www.phpbb.com) phpBB is a free open-source bulletin board written in PHP. diff --git a/phpBB/styles/all/imgs/svg/phpbb_logo.svg b/phpBB/styles/all/imgs/svg/phpbb_logo.svg new file mode 100644 index 0000000000..a3e2cbe4e9 --- /dev/null +++ b/phpBB/styles/all/imgs/svg/phpbb_logo.svg @@ -0,0 +1,1264 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/phpBB/styles/prosilver/theme/images/site_logo_blue.svg b/phpBB/styles/prosilver/theme/images/site_logo_blue.svg deleted file mode 100644 index 0fa38b9331..0000000000 --- a/phpBB/styles/prosilver/theme/images/site_logo_blue.svg +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - From 52217bd4e453acdecf98eba5d28f4ffc389ca924 Mon Sep 17 00:00:00 2001 From: Matt Friedman Date: Fri, 2 Oct 2020 00:15:22 -0700 Subject: [PATCH 4/5] [ticket/16608] Cosmic Logo PHPBB3-16608 --- README.md | 2 +- phpBB/styles/all/imgs/svg/phpbb_logo.svg | 1264 ----------------- .../all/imgs/svg/phpbb_logo_large_cosmic.svg | 6 + 3 files changed, 7 insertions(+), 1265 deletions(-) delete mode 100644 phpBB/styles/all/imgs/svg/phpbb_logo.svg create mode 100644 phpBB/styles/all/imgs/svg/phpbb_logo_large_cosmic.svg diff --git a/README.md b/README.md index f75f0be379..cfb582bb3c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![phpBB](phpBB/styles/all/imgs/svg/phpbb_logo.svg)](https://www.phpbb.com) +[![phpBB](phpBB/styles/all/imgs/svg/phpbb_logo_large_cosmic.svg)](https://www.phpbb.com) phpBB is a free open-source bulletin board written in PHP. diff --git a/phpBB/styles/all/imgs/svg/phpbb_logo.svg b/phpBB/styles/all/imgs/svg/phpbb_logo.svg deleted file mode 100644 index a3e2cbe4e9..0000000000 --- a/phpBB/styles/all/imgs/svg/phpbb_logo.svg +++ /dev/null @@ -1,1264 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/phpBB/styles/all/imgs/svg/phpbb_logo_large_cosmic.svg b/phpBB/styles/all/imgs/svg/phpbb_logo_large_cosmic.svg new file mode 100644 index 0000000000..0fa38b9331 --- /dev/null +++ b/phpBB/styles/all/imgs/svg/phpbb_logo_large_cosmic.svg @@ -0,0 +1,6 @@ + + + + + + From 8ad14af39c2d22bc7989903251912078a426fc7a Mon Sep 17 00:00:00 2001 From: Matt Friedman Date: Fri, 2 Oct 2020 09:42:07 -0700 Subject: [PATCH 5/5] [ticket/16608] Add documentation info PHPBB3-16608 --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index cfb582bb3c..1cb10c664b 100644 --- a/README.md +++ b/README.md @@ -17,19 +17,22 @@ Get your copy of phpBB, find support and lots more on [phpBB.com](https://www.ph To run an installation from the repo (and not from a pre-built package) on a local server, run the following commands: -```bash -## Fork phpbb/phpbb to your GitHub account, then create a local clone of it: - -git clone git://github.com/your_github_name/phpbb.git - -## Install phpBB's dependencies (from the root of your phpbb repo): - -cd phpBB -php ../composer.phar install -``` +- Fork phpbb/phpbb to your GitHub account, then create a local clone of it: + ``` + git clone https://github.com/your_github_name/phpbb.git + ``` +- Install phpBB's dependencies (from the root of your phpbb repo): + ``` + cd phpBB + php ../composer.phar install + ``` Alternatively, you can read our [Vagrant documentation](phpBB/docs/vagrant.md) to find out how to use Vagrant to develop and contribute to phpBB. +## 📓 Documentation + +phpBB's [Development Documentation](https://area51.phpbb.com/docs/dev/index.html) contains all the information you'll need to learn about developing for phpBB's core, extensions and automated testing. + ## 🔬 Automated Testing We have unit and functional tests in order to prevent regressions. You can view the bamboo continuous integration [here](https://bamboo.phpbb.com) or check our travis builds below: