From f5ab0e2a22a50332da5e3ce259e5e929b891f89b Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Fri, 9 Oct 2015 18:35:49 +0000 Subject: Replace "Contact" section with "Getting help" This also adds a mention of the IRC channel. Worthy read: "Readme Driven Development" by Tom Preston-Werner: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c6b5caf..c6d536b 100644 --- a/README.md +++ b/README.md @@ -50,11 +50,15 @@ add to your `.htaccess` file: Remember to enable `deflate_module` and `filter_module` modules in your Apache configuration file. +## Getting help + +The Pantsu.cat community gathers on IRC. You can also email the maintainer for +help. + +- IRC: `#pantsucat` on Partyvan (`irc.partyvan.eu`) +- Email: + ## License Pomf is free software, and is released under the terms of the Expat license. See `LICENSE`. - -## Contact - -The maintainer can be contacted via . -- cgit v1.2.3 From 40a2e0dbff27dfa5f5bd1db3d5e59586b6f35186 Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Fri, 9 Oct 2015 18:53:17 +0000 Subject: Add "Credits" section to README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index c6d536b..4b943a3 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,12 @@ help. - IRC: `#pantsucat` on Partyvan (`irc.partyvan.eu`) - Email: +## Credits + +Pomf was created by Eric Johansson and Peter Lejeck for +[Pomf.se](https://pomf.se/). The software is currently maintained by the +community. + ## License Pomf is free software, and is released under the terms of the Expat license. See -- cgit v1.2.3 From 0e0d9c3915c6a5b344bf49f87b1a4c52ad6c2022 Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Fri, 9 Oct 2015 18:55:47 +0000 Subject: Replace Pomf.se HTTPS link to HTTP in README.md It seems neku doesn't have a working HTTPS website anymore. It certainly used to. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b943a3..0353c16 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ help. ## Credits Pomf was created by Eric Johansson and Peter Lejeck for -[Pomf.se](https://pomf.se/). The software is currently maintained by the +[Pomf.se](http://pomf.se/). The software is currently maintained by the community. ## License -- cgit v1.2.3 From cba9ff1b194a99084d47ce0cace35ba32035175d Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Fri, 9 Oct 2015 19:18:45 +0000 Subject: Add "Contributing" section to README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Worthy read: "Top ten reasons why I won’t use your open source project" by Adam Stacoviak. https://changelog.com/top-ten-reasons-why-i-wont-use-your-open-source-project/ --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 0353c16..11cadb1 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,23 @@ help. - IRC: `#pantsucat` on Partyvan (`irc.partyvan.eu`) - Email: +## Contributing + +For source code changes, please submit `git-format-patch(1)` formatted patches +by email or come talk to us on IRC. See "Getting help". At this time, we do not +use the issue tracker on `git.pantsu.cat` to track issues/pull requests. + +We'd really like if you can take some time to make sure your coding style is +consistent with the project. Pomf follows [PHP +PSR-2](http://www.php-fig.org/psr/psr-2/) and [Airbnb JavaScript +(ES5)](https://github.com/airbnb/javascript/tree/master/es5) (`airbnb/legacy`) +coding style guides. We use ESLint and PHPCS tools to enforce these standards. + +You can also help by sending us feature requests and writing documentation and +tests. + +Thanks! + ## Credits Pomf was created by Eric Johansson and Peter Lejeck for -- cgit v1.2.3 From b5428f54383c557dd26398f442bd3d8d28ef30fb Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Fri, 9 Oct 2015 19:21:18 +0000 Subject: Linkify git.pantsu.cat in README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11cadb1..0ef505e 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,8 @@ help. For source code changes, please submit `git-format-patch(1)` formatted patches by email or come talk to us on IRC. See "Getting help". At this time, we do not -use the issue tracker on `git.pantsu.cat` to track issues/pull requests. +use the issue tracker on [git.pantsu.cat](https://git.pantsu.cat/) to track +issues/pull requests. We'd really like if you can take some time to make sure your coding style is consistent with the project. Pomf follows [PHP -- cgit v1.2.3 From 161042a1862f8e1991828970fc0d766efdf449c5 Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Fri, 9 Oct 2015 19:29:13 +0000 Subject: Clarify IRC usage for contribution merge requests We use IRC for code review, so naturally merge requests also happen there. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0ef505e..4f109a1 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,9 @@ help. ## Contributing For source code changes, please submit `git-format-patch(1)` formatted patches -by email or come talk to us on IRC. See "Getting help". At this time, we do not -use the issue tracker on [git.pantsu.cat](https://git.pantsu.cat/) to track -issues/pull requests. +by email or come talk to us on IRC to merge your branch. See "Getting help". At +this time, we do not use the issue tracker on +[git.pantsu.cat](https://git.pantsu.cat/) to track issues/pull requests. We'd really like if you can take some time to make sure your coding style is consistent with the project. Pomf follows [PHP -- cgit v1.2.3 From 655c6aaeb9b7d74cc5a43fb0d719e896f0f0d11c Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Fri, 9 Oct 2015 20:37:37 +0000 Subject: Rewrite "Configuring" section to be more confident The previous example can create a feeling of worry in the mind of the reader. This will aim to fix that. --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4f109a1..c952895 100644 --- a/README.md +++ b/README.md @@ -28,17 +28,20 @@ After this, the pomf site is now compressed and set up inside `dist/`. ## Configuring -The majority of settings are in `static/includes/settings.inc.php`. Read the -comments in that file for more information. +The majority of settings are in `static/includes/settings.inc.php`. -For file size configuration, there is no server-side verification: we assume -that PHP and Nginx provide ample protection in this department. There is, -however, client-side configuration for max size, the `data-max-size` attribute -on the file input in `pages/upload_form.swig`. +For file size configuration, open `Gruntfile.js` in an editor and modify the +`max_upload_size` value. The value is expressed in mebibytes (MiB). Run `grunt` +again to rebuild the pages for the changes to take effect. -Make sure to disable PHP from being executed on the file download -domain/directory (e.g., `a.pomf.example`), otherwise an attacker can upload a -malicious `.php` file and execute it on your server. +If you intend to allow uploading files larger than 2 MB, you may also need to +increase POST size limits in `php.ini` and webserver configuration. For PHP, +modify `upload_max_filesize` and `post_max_size` values. The configuration +option for nginx webserver is `client_max_body_size`. + +A best practice is to disable executing `.php` files on the `POMF_URL` domain +for uploaded files. This assures that a malicious user cannot execute arbitrary +PHP code on the server. ### Apache -- cgit v1.2.3 From 8c34421929396fa2910c875537c976bdb941859b Mon Sep 17 00:00:00 2001 From: Juuso Lapinlampi Date: Sat, 10 Oct 2015 16:05:33 +0000 Subject: Fix README.md grammar Thanks to alchimist@ for doing editorial review. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c952895..7e1f49b 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ After this, the pomf site is now compressed and set up inside `dist/`. ## Configuring -The majority of settings are in `static/includes/settings.inc.php`. +The majority of the settings are in `static/includes/settings.inc.php`. For file size configuration, open `Gruntfile.js` in an editor and modify the `max_upload_size` value. The value is expressed in mebibytes (MiB). Run `grunt` @@ -74,7 +74,7 @@ PSR-2](http://www.php-fig.org/psr/psr-2/) and [Airbnb JavaScript (ES5)](https://github.com/airbnb/javascript/tree/master/es5) (`airbnb/legacy`) coding style guides. We use ESLint and PHPCS tools to enforce these standards. -You can also help by sending us feature requests and writing documentation and +You can also help by sending us feature requests or writing documentation and tests. Thanks! -- cgit v1.2.3