Skip to content

Commit 89f619a

Browse files
committed
Readme update.
1 parent 77e5d5d commit 89f619a

File tree

1 file changed

+18
-24
lines changed

1 file changed

+18
-24
lines changed

README.md

+18-24
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,15 @@ I forgot about.
1919

2020
This board follows the Acmlmboard concept. If you don't know Acmlmboard, you don't know what you're missing.
2121

22-
-------------------------------------------------------------------------------
23-
24-
# Requirements
22+
## Requirements
2523

26-
Blargboard requires PHP 5.3. With a few changes, it could be lowered to 5.2, so this will
27-
be considered.
24+
Blargboard requires PHP 5.3. You also need the mcrypt extension.
2825

2926
There is no exact requirement for MySQL, but make sure to have a recent version.
3027

3128
Everything else is provided in the package.
3229

33-
-------------------------------------------------------------------------------
34-
35-
# How to install and use
30+
## How to install and use
3631

3732
PHP and MySQL knowledge isn't required to use Blargboard but is a plus.
3833

@@ -45,12 +40,15 @@ If everything went fine, browse to your freshly installed board and configure it
4540
We recommend you take some time and make your own board themes and banner to give your board a truly unique feel.
4641
If you have HTML knowledge, you can even edit the templates to change your board's look more in-depth.
4742

48-
DO NOT TRY USING THE PROVIDED PLUGINS. They haven't be adapted to the newer Blargboard
49-
codebase yet. Some may work, but others may break parts of your board.
43+
## Working plugins
5044

51-
-------------------------------------------------------------------------------
45+
The following plugins have been updated and are known to work with current Blargboard. Any other plugins in the repo are probably broken, so don't try using them.
46+
47+
* CustomUserNameColors
48+
* ircreport
49+
* layoutblockstats
5250

53-
# How to update your board
51+
## How to update your board
5452

5553
Download the most recent Blargboard package (be it an official release or a Git package).
5654

@@ -66,9 +64,7 @@ Depending on the versions, your update may involve running extra scripts to fix
6664

6765
Updating from Blargboard 1.0 isn't covered.
6866

69-
-------------------------------------------------------------------------------
70-
71-
# Features
67+
## Features
7268

7369
* Flexible permission system
7470
* Plugin system
@@ -91,9 +87,7 @@ been adapted to Blargboard's database structure yet. Thus, when updating your Bl
9187
copy, you need to check for changes to database.sql and modify your database's structure
9288
accordingly.
9389

94-
-------------------------------------------------------------------------------
95-
96-
# Board owner's tips
90+
## Board owner's tips
9791

9892
http://board.example/?page=makelr -> regenerates the L/R tree used for forum listings and such.
9993
Use if some of your forums are showing up in wrong places.
@@ -118,19 +112,18 @@ WARNING: when banning someone, make sure that the secondary groups' permissions
118112

119113
How to (insert action): first look into your board's admin panel, settings panel, etc... then if you still can't find, ask us. But please don't be a noob and ask us about every little thing.
120114

121-
-------------------------------------------------------------------------------
122-
123-
# Support
115+
## Support, troubleshooting, etc
124116

125117
The Blargboard help forum is at Kuribo64: http://kuribo64.net/?page=forum&id=82
126118

127119
If anything goes wrong with your board, go there and let us know. Make sure to describe your problems in detail, our crystal ball is scratched so we can't see well.
128120

129-
YOU WILL NOT RECEIVE HELP IF YOU HAVEN'T READ THE INSTRUCTIONS WHEN INSTALLING YOUR BOARD.
121+
If the error is a 'MySQL Error', to get a detailed report, you need to open config/database.php in a text editor, find `$debugMode = 0;` and replace it with `$debugMode = 1;`.
122+
This will make the board give you the MySQL error message and the query which went wrong. Once you're done troubleshooting your board, it is recommended that you edit config/database.php back so that `$debugMode` is 0.
130123

131-
-------------------------------------------------------------------------------
124+
YOU WILL NOT RECEIVE HELP IF YOU HAVEN'T READ THE INSTRUCTIONS WHEN INSTALLING YOUR BOARD.
132125

133-
# TODO list
126+
## TODO list
134127

135128
(no particular order there)
136129

@@ -142,6 +135,7 @@ YOU WILL NOT RECEIVE HELP IF YOU HAVEN'T READ THE INSTRUCTIONS WHEN INSTALLING Y
142135
* more TODO at Kuribo64 and RVLution
143136

144137
* low priority: change/remove file headers? most of the original files still say 'AcmlmBoard XD'
138+
* besides it'd be an opportunity to add a license like the GPL
145139

146140
-------------------------------------------------------------------------------
147141

0 commit comments

Comments
 (0)