Răsfoiți Sursa

* README / docs updates

Bryan Drewery 17 ani în urmă
părinte
comite
5b9ff7f3ea
4 a modificat fișierele cu 44 adăugiri și 31 ștergeri
  1. 1 1
      LICENSE
  2. 40 22
      README
  3. 1 6
      doc/CREDITS
  4. 2 2
      src/cmds.c

+ 1 - 1
LICENSE

@@ -1,7 +1,7 @@
 ****************************************************************
 ****************************************************************
 ANY REDISTRIBUTION OF THIS SOURCE OR DERIVATIVES OF THIS SOURCE 
-MUST INCLUDE THIS FILE, DOC/CREDITS, CMD_ABOUT, AND FILE HEADERS
+MUST INCLUDE THIS FILE, README, DOC/CREDITS, CMD_ABOUT, AND FILE HEADERS
 WITH LICENSING/COPYRIGHTS.
 CMD_ABOUT MUST INCLUDE: CREDITS TO BRYAN/EGGDEV/GHOST AND THE 
 OFFICIAL WRAITH URL (http://wraith.botpack.net)

+ 40 - 22
README

@@ -6,37 +6,55 @@ __  _  ______________  |__|/  |_|  |__
                      \/              \/
        http://wraith.botpack.net
 
-Wraith is an IRC bot written in C++. It has been in development since late 2003. 
-It is based on Eggdrop 1.6.12 but has since evolved into something much different at its core.
+Wraith is an IRC bot written purely in C/C++. It has been in development since late 2003.
+It is based on Eggdrop 1.6.12 but has since evolved into something much different at its
+core. TCL and loadable modules are currently not supported.
 
-Wraith aims to be a secure and easy to setup and manage botnet. 
-A botnet can be setup in a matter of minutes and updated later with 1 command. 
-Leaf bots save no files locally, but rather store configuration in their own binary. 
+Wraith aims to be a secure and easy to setup and manage botnet.
+A botnet can be setup in a matter of minutes and updated later with 1 command.
+Leaf bots save no files locally, but rather store configuration encrypted in their own binary.
 Hubs do not connect to IRC, and keep a local encrypted copy of the userfile.
 
-All official documentation and releases can be found on the site.
+All official sites, documentation, support venues, repositories and source urls are referenced here.
+
+Source URL scheme: http://botpack.net/wraith-BRANCH.tar.gz
+Pre-compiled Binary URL scheme: http://botpack.net/wraith.SYSTEM-BRANCH.tar.gz
+  Binaries are 32bit i486.
+  SYSTEM is either Linux or FreeBSD (case sensitive)
+  BRANCH is one of:
+    release - current release
+    stable  - git:master - changes ready for the next release
+    devel   - git:next - unstable changes being tested potentially for next release.
+  These binaries will not work on Linux 2.4,<2.6.20 or FreeBSD 4.
+  Example: http://botpack.net/wraith.FreeBSD-release.tar.gz
 
 Official Git repositories:
-git://git.shatow.net/wraith.git
-git://github.com/bdrewery/wraith.git
+  git://git.shatow.net/wraith.git
+  git://github.com/bdrewery/wraith.git
+  git://gitorious.org/wraith/mainline.git
+  git://repo.or.cz/wraith.git
+
+See git for a list of Contributors: git shortlog -sen master
+
+Support:
+  How To Contribute: http://wraith.botpack.net/wiki/Contributing
+  Getting Started: http://wraith.botpack.net/wiki/GettingStarted
+  FAQ: http://wraith.botpack.net/wiki/FrequentlyAskedQuestions
+  Documentation Index: http://wraith.botpack.net/wiki/Documentation
+  Bugs can be reported at: http://wraith.botpack.net/newticket
+  Bugs can be looked up by #, ie, '#24' in url: http://wraith.botpack.net/ticket/24
+  #wraith @ EFnet
 
-For a list of Contributors see: git log master|git shortlog -sen
-To Contribute see: http://wraith.botpack.net/wiki/Contributing
-Bugs can be reported at: http://wraith.botpack.net/newticket
-Bugs can be looked up by #, ie, '#24' in url: http://wraith.botpack.net/ticket/24
 Please support wraith by signing up for a shell at http://www.xzibition.com (coupon 'wraith' for 30% off)
 
 The botpack ghost inspired the early versions of wraith and a few cmds.
-* einride
-* ievil
+  einride
+  ievil
 
 The following botpacks gave inspiration, ideas, and some code:
-* awptic by lordoptic
-* optikz by ryguy and lordoptic
-* celdrop by excelsior
-* genocide by Crazi, Dor, psychoid, and Ace24
-* tfbot by warknite and loslinux
-
+  awptic by lordoptic
+  optikz by ryguy and lordoptic
+  celdrop by excelsior
+  genocide by Crazi, Dor, psychoid, and Ace24
+  tfbot by warknite and loslinux
 
-NEVER upload your pack.cfg to an untrusted shell.
-#wraith @ EFnet

+ 1 - 6
doc/CREDITS

@@ -16,12 +16,7 @@ Credits and thanks to the following:
 * Mystikal for various bugs.
 * Many others.
 
-For a list of Contributors see: git log master|git shortlog -sen
-To Contribute see: http://wraith.botpack.net/wiki/Contributing
-Credit for suggestions/bugs can be found at: http://wraith.botpack.net/report/9
-Bugs can be reported at: http://wraith.botpack.net/newticket
-Bugs can be looked up by #, ie, '#24' in url: http://wraith.botpack.net/ticket/24
-Please support wraith by signing up for a shell at http://www.xzibition.com (coupon 'wraith' for 30% off)
+For a list of code Contributors see: git shortlog -sen master
 
 The botpack ghost inspired the early versions of wraith and a few cmds.
 * einride

+ 2 - 2
src/cmds.c

@@ -411,14 +411,14 @@ static void cmd_about(int idx, char *par)
   dprintf(idx, STR(" * $bMystikal$b for various bugs.\n"));
   dprintf(idx, STR(" * $bMany$b others.\n"));
   dprintf(idx, " \n");
-  dprintf(idx, STR("For a list of Contributors see: git log master|git shortlog -sen\n"));
+  dprintf(idx, STR("For a list of Contributors see: git shortlog -sen master\n"));
   dprintf(idx, STR("To Contribute see: http://wraith.botpack.net/wiki/Contributing\n"));
   dprintf(idx, STR("Credit for suggestions/bugs can be found at: http://wraith.botpack.net/report/9\n"));
   dprintf(idx, STR("Bugs can be reported at: http://wraith.botpack.net/newticket\n"));
   dprintf(idx, STR("Bugs can be looked up by #, ie, '#24' in url: http://wraith.botpack.net/ticket/24\n"));
+  dprintf(idx, " \n");
   dprintf(idx, STR("Please support wraith by signing up for a shell at http://www.xzibition.com (coupon 'wraith' for 30% off)\n"));
   dprintf(idx, " \n");
-
   dprintf(idx, STR("The botpack ghost inspired the early versions of wraith and a few cmds.\n"));
   dprintf(idx, STR("* $beinride$b\n"));
   dprintf(idx, STR("* $bievil$b\n"));