vb.org Archive

vb.org Archive (https://vborg.vbsupport.ru/index.php)
-   vB3 General Discussions (https://vborg.vbsupport.ru/forumdisplay.php?f=111)
-   -   Generalising Hack's Readme File (https://vborg.vbsupport.ru/showthread.php?t=36325)

MW[MWGN] 03-19-2002 08:11 PM
Generalising Hack's Readme File
 
]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....

Quote:
*******************************************
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. :)


All times are GMT. The time now is 12:36 AM.

Powered by vBulletin® Version 3.8.12 by vBS
Copyright ©2000 - 2025, vBulletin Solutions Inc.

X vBulletin 3.8.12 by vBS Debug Information
  • Page Generation 0.00898 seconds
  • Memory Usage 1,712KB
  • Queries Executed 10 (?)
More Information
Template Usage:
  • (1)ad_footer_end
  • (1)ad_footer_start
  • (1)ad_header_end
  • (1)ad_header_logo
  • (1)ad_navbar_below
  • (1)bbcode_quote_printable
  • (1)footer
  • (1)gobutton
  • (1)header
  • (1)headinclude
  • (6)option
  • (1)post_thanks_navbar_search
  • (1)printthread
  • (2)printthreadbit
  • (1)spacer_close
  • (1)spacer_open 
Phrase Groups Available:
  • global
  • postbit
  • showthread
Included Files:
  • ./printthread.php
  • ./global.php
  • ./includes/init.php
  • ./includes/class_core.php
  • ./includes/config.php
  • ./includes/functions.php
  • ./includes/class_hook.php
  • ./includes/modsystem_functions.php
  • ./includes/class_bbcode_alt.php
  • ./includes/class_bbcode.php
  • ./includes/functions_bigthree.php 
Hooks Called:
  • init_startup
  • init_startup_session_setup_start
  • init_startup_session_setup_complete
  • cache_permissions
  • fetch_threadinfo_query
  • fetch_threadinfo
  • fetch_foruminfo
  • style_fetch
  • cache_templates
  • global_start
  • parse_templates
  • global_setup_complete
  • printthread_start
  • bbcode_fetch_tags
  • bbcode_create
  • bbcode_parse_start
  • bbcode_parse_complete_precache
  • bbcode_parse_complete
  • printthread_post
  • printthread_complete