summaryrefslogtreecommitdiff
path: root/scripts/README
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/README')
-rw-r--r--scripts/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/scripts/README b/scripts/README
new file mode 100644
index 0000000..f2040ae
--- /dev/null
+++ b/scripts/README
@@ -0,0 +1,17 @@
+All scripts should be run from the yChat main directory, example:
+
+./scripts/makeyhttpd.pl
+
+A ./makeyhttpd.pl WILL NOT work :)
+
+astyle.sh - Uses the astyle tool for source code formatting
+buildnr.pl - Increments the yChat build number by one
+checkperl.sh - Checks which perl to use [obsolete]
+config.pl - yChat configurator [obsolete]
+makedist.sh - Creates a yChat destribution package [broken]
+makeyhttpd.pl - Generates yhttpd sourcecode [broken]
+modules/ - Contains perl subroutines
+screen.sh - Starts yChat inside of a screen session
+setglobvals.pl - Sets some variables inside of the ./src/glob.h file
+stats.pl - Generates and prints out some source code statistics
+version.sh - Prints out the current yChat version