Log in

View Full Version : Generalising Hack's Readme File


MW[MWGN]
03-19-2002, 08:11 PM
]I was thinking... if all the hackers can generalise their readme files of their hacks, i.e. every hacker uses the same format of readme, then it would be easier for the users (perhaps? :)) to understand. Personally, I would prefer my format....

*******************************************
HACK TITLE - by NAME
*******************************************

/// What is it?
Description of hack....

/// Notes
Any other things you would like to mention, e.g. compatibility of vB versions

/// Credits
Anyone you would like to thank for inspiring you, or helped you in the writing of the hack etc..

///Installation
For example
*Open /index.php
Find:
----------------------------------------------------------------
bla bla
----------------------------------------------------------------

Add BELOW:
----------------------------------------------------------------
bla bla bla
----------------------------------------------------------------
Save and upload!

Now, add template....
----------------------------------------------------------------
blabla
----------------------------------------------------------------
Then open up the template... and add templatename...
That's all!

-YOURNAME
YOUREMAIL
Just my suggestion...

Admin
03-20-2002, 04:41 AM
It's something the "MODDERS" at phpBB2 do, but frankly I don't really see a use for this. As long as the file is not too cluttered and the users can understand what goes where etc., it's all ok. :)