From ad4d8ee0db2d1833a368ebee2099898cf251af97 Mon Sep 17 00:00:00 2001 From: Paul Merrill Date: Thu, 4 Nov 2010 06:56:21 -0700 Subject: [PATCH 1/8] Converted readme to unix line endings. Added part about instance-config.php. --- README.md | 91 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 46 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 3c9a6bf3..fd4e0f3b 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,46 @@ -# Tinyboard - A lightweight PHP imageboard. - -## About -Tinyboard is an imageboard software package written in PHP. It aims to maintain a stable, fast, clean and user-friendly engine for imageboards. Development for Tinyboard started in October 2010 and the project is being lead by [OmegaSDG][o] ("Omega Software Develop Group"). You can contact the development team over IRC at irc.n0v4.com #tinyboard. - -Tinyboard is not currently at a stable state. - -[o]: http://omegadev.org/ - -## Installation - 1. Tinyboard requires a MySQL database and a user to work. Create one. - 2. Import 'install.sql' into the database. There are several ways to do this. - - using phpMyAdmin - - `mysql -uUSERNAME -pPASSWORD DATABASE < install.sql` - 3. Edit '[inc/config.php][c]' to suit your installation - 4. Make sure that the directories used by Tinyboard are writable. Depending on your setup, you may need to `chmod` the directories to 777. - The default directories are: - - ./res - - ./src - - ./thumb - - . (document root) - 5. Ensure everything is okay by running [test.php][t] in a browser. The script will try and help you correct your errors. - 6. Run the [post.php][p] script. It should create an index.html and redirect you to it if everything is okay. - 7. Optional (highly recommended): Either delete or chmod as unreadable the following files: [test.php][t], [install.sql][i], and this [README][r]. - -[t]: http://github.com/savetheinternet/Tinyboard/blob/master/test.php -[p]: http://github.com/savetheinternet/Tinyboard/blob/master/post.php -[c]: http://github.com/savetheinternet/Tinyboard/blob/master/inc/config.php -[i]: http://github.com/savetheinternet/Tinyboard/blob/master/install.sql -[r]: http://github.com/savetheinternet/Tinyboard/blob/master/README.md - -## License -Copyright (c) 2010 by Omega Software Development Group - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above copyright -notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. \ No newline at end of file +# Tinyboard - A lightweight PHP imageboard. + +## About +Tinyboard is an imageboard software package written in PHP. It aims to maintain a stable, fast, clean and user-friendly engine for imageboards. Development for Tinyboard started in October 2010 and the project is being lead by [OmegaSDG][o] ("Omega Software Develop Group"). You can contact the development team over IRC at irc.n0v4.com #tinyboard. + +Tinyboard is not currently at a stable state. + +[o]: http://omegadev.org/ + +## Installation + 1. Tinyboard requires a MySQL database and a user to work. Create one. + 2. Import 'install.sql' into the database. There are several ways to do this. + - using phpMyAdmin + - `mysql -uUSERNAME -pPASSWORD DATABASE < install.sql` + 3. Create an 'instance-config.php'. It should be a PHP script that redefines some values in '[inc/config.php][c]' to suit your installation. + 4. Make sure that the directories used by Tinyboard are writable. Depending on your setup, you may need to `chmod` the directories to 777. + The default directories are: + - ./res + - ./src + - ./thumb + - . (document root) + 5. Ensure everything is okay by running [test.php][t] in a browser. The script will try and help you correct your errors. + 6. Run the [post.php][p] script. It should create an index.html and redirect you to it if everything is okay. + 7. Optional (highly recommended): Either delete or chmod as unreadable the following files: [test.php][t], [install.sql][i], and this [README][r]. + +[t]: http://github.com/savetheinternet/Tinyboard/blob/master/test.php +[p]: http://github.com/savetheinternet/Tinyboard/blob/master/post.php +[c]: http://github.com/savetheinternet/Tinyboard/blob/master/inc/config.php +[i]: http://github.com/savetheinternet/Tinyboard/blob/master/install.sql +[r]: http://github.com/savetheinternet/Tinyboard/blob/master/README.md + +## License +Copyright (c) 2010 by Omega Software Development Group + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above copyright +notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + From 0296a7666f4e9fa2827edf6cc095fb05ad73440b Mon Sep 17 00:00:00 2001 From: Savetheinternet Date: Fri, 5 Nov 2010 01:02:13 +1100 Subject: [PATCH 2/8] Comments in configs --- inc/config.php | 15 +++++++++++++++ inc/instance-config.php | 19 +++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 inc/instance-config.php diff --git a/inc/config.php b/inc/config.php index 43f4a449..66b1e815 100644 --- a/inc/config.php +++ b/inc/config.php @@ -1,4 +1,19 @@ \ No newline at end of file From abc0cda57505b3040d8340e2d7e2d99edf55e354 Mon Sep 17 00:00:00 2001 From: Savetheinternet Date: Fri, 5 Nov 2010 01:06:53 +1100 Subject: [PATCH 3/8] ASCII art fix --- inc/config.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/inc/config.php b/inc/config.php index 66b1e815..c29b1861 100644 --- a/inc/config.php +++ b/inc/config.php @@ -4,11 +4,11 @@ * .d88888b d888888P .88888. 888888ba * 88. "' 88 d8' `8b 88 `8b * `Y88888b. 88 88 88 a88aaaa8P' - * `8b 88 88 88 88 + * `8b 88 88 88 88 * d8' .8P 88 Y8. .8P 88 * Y88888P dP `8888P' dP * - * Do not edit this file. Edit instance-config instead! + * Do not edit this file. Edit instance-config.php instead! * * This is the default configuration. You can copy values from here and use them in * your instance-config.php From 512227eaa946cdafb82ca6640db9e68a12de01e3 Mon Sep 17 00:00:00 2001 From: Savetheinternet Date: Fri, 5 Nov 2010 01:08:01 +1100 Subject: [PATCH 4/8] ASCII art fix --- inc/config.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/inc/config.php b/inc/config.php index c29b1861..4f38bb7e 100644 --- a/inc/config.php +++ b/inc/config.php @@ -1,12 +1,12 @@ Date: Fri, 5 Nov 2010 01:09:25 +1100 Subject: [PATCH 5/8] ASCII art fix --- inc/config.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/inc/config.php b/inc/config.php index 4f38bb7e..5e60f7e1 100644 --- a/inc/config.php +++ b/inc/config.php @@ -4,7 +4,7 @@ * .d88888b d888888P .88888. 888888ba * 88. "' 88 d8' `8b 88 `8b * `Y88888b. 88 88 88 a88aaaa8P' - * `8b 88 88 88 88 + * `8b 88 88 88 88 * d8' .8P 88 Y8. .8P 88 * Y88888P dP `8888P' dP * From 20a8dff1498749137521e92e80a234326f108bf4 Mon Sep 17 00:00:00 2001 From: Savetheinternet Date: Fri, 5 Nov 2010 01:10:45 +1100 Subject: [PATCH 6/8] Removal of ASCII --- inc/config.php | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/inc/config.php b/inc/config.php index 5e60f7e1..ecd51761 100644 --- a/inc/config.php +++ b/inc/config.php @@ -1,12 +1,7 @@ Date: Fri, 5 Nov 2010 01:16:23 +1100 Subject: [PATCH 7/8] Informing instead of demanding with the "do not edit" sign. --- inc/config.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/inc/config.php b/inc/config.php index ecd51761..fbbfaa74 100644 --- a/inc/config.php +++ b/inc/config.php @@ -1,7 +1,8 @@ Date: Fri, 5 Nov 2010 01:18:23 +1100 Subject: [PATCH 8/8] Shorten warning --- inc/config.php | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/inc/config.php b/inc/config.php index fbbfaa74..ce005839 100644 --- a/inc/config.php +++ b/inc/config.php @@ -1,10 +1,8 @@