Permalink
Browse files

Revised README.md Install/Upgrade instructions and added file for tem…

…plating documentation.
  • Loading branch information...
PhillF
PhillF committed Apr 10, 2012
1 parent 4f0a459 commit da7b079a698b1491d8b143bb0bd8a6c2c60eaa8d
Showing with 20 additions and 3 deletions.
  1. +5 −3 README.md
  2. +15 −0 docs/TEMPLATING.md
View
@@ -62,11 +62,13 @@ To use this feature **enable** the following parameters by removing the '#' in f
Installation
------------
-1. sPull the latest MagIRC package from https://github.com/h9k/magirc/.
+1. Pull the latest MagIRC package from https://github.com/h9k/magirc/.
2. Extract the MagIRC archive to your web server and move it's conetent to the MagIRC directory.
-3. Use your web browser to navigate to the setup folder on your server and follow on-screen instructions. Example: http://yourpathtomagirc/setup
+3. Use your web browser to navigate to the setup folder on your server and follow on-screen instructions.
+ Example: http://`yourpathtomagirc`/setup
-Note: If you are on Apache you can enable mod_rewrite by using "a2enmod rewrite; service apache2 restart" and rename htaccess.txt in the root to .htaccess.
+Note: If you are on Apache you can enable mod_rewrite by using "a2enmod rewrite; service apache2 restart"
+and rename htaccess.txt in the root to .htaccess.
Upgrading
---------
View
@@ -1,2 +1,17 @@
MagIRC - Templating
===================
+
+MagIRC uses the Smarty template engine which makes many useful variables available.
+
+
+Referencing a Variable
+======================
+
+To reference a variable simple use {$parent.variable}
+
+For example if you want the network's name then use {$cfg.net_name}
+
+
+
+Variables
+=========

0 comments on commit da7b079

Please sign in to comment.