summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Merrill <napalminc@gmail.com>2010-11-04 06:56:21 -0700
committerPaul Merrill <napalminc@gmail.com>2010-11-04 06:56:21 -0700
commitad4d8ee0db2d1833a368ebee2099898cf251af97 (patch)
treee1cc649028b893dbdf9f4663cd366903ba9f1f95
parent05dd518cb9ff2788f8b8d5dfc15ae511f7df7729 (diff)
Converted readme to unix line endings. Added part about instance-config.php.
-rw-r--r--README.md91
1 files 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.
+