______             __            
 __/\__  _\           /\ \__         
/\_\/_/\ \/ __  __  __\ \ ,_\  _ __  
\/\ \ \ \ \/\ \/\ \/\ \\ \ \/ /\`'__\
 \ \ \ \ \ \ \ \_/ \_/ \\ \ \_\ \ \/ 
  \ \_\ \ \_\ \___x___/' \ \__\\ \_\ 
   \/_/  \/_/\/__//__/    \/__/ \/_/

An open source Twitter client for iPhones


License
-------

iTwtr is released under an MIT license. For more exciting details, see the
included license.txt or download it at http://itwtr.com/license.txt.


Prerequisites
-------------

To install your own instance of the iTwtr server software you will need:

  - A server with web space
  - Means of transferring files to said server
  - A PHP-enabled webserver (only known to work with Linux/Apache)
  - SQLite extension for PHP (preferably version 3, enabled via PDO)
  - cURL extension for PHP


Preparing your server
---------------------

If you have all these things, follow these steps to install: 

  1. Unzip the iTwtr source code (available at http://itwtr.com/download)
  
  2. Upload the files to a new directory in your server's web space. Note that
     only the "public" directory should be made available to the web.
  
  3. Load the directory in a web browser. If you see a message complaining about
     config.php not being found, try modifying the $itwtr_dir variable at the
     top of setup.php.
  
If all goes well, you should see a page with a few more installation steps to
follow. These steps are described in the next section.


Installing
----------

  1. If you see a message complaining about disk permissions, you will need to
     modify the store directory so that the web server can write to it.
     
     Example: $ cd /path/to/itwtr
              $ chown www:www store
     
     The exact commands will depend on what user your web server runs as and
     where you've installed iTwtr. 
  
  2. Install a cron job to execute cron.php on some regular interval. You can
     set the cron interval to be every minute and each Twitter feed will still
     only download as frequently as it has been configured.
     
     Example: $ crontab -e
     
     * * * * * /path/to/php -f /path/to/itwtr/cron.php >/dev/null 2>&1
     
     (Be sure to leave an extra line break at the end of your crontab rules.)
  
  3. Double-check that only your *public* directory has been exposed to the web.
     This is important because if your account database file is made public,
     people could download it and have access to your Twitter login information.
  
  4. Edit config.php to taste.
  
  5. Reload the installation page.
  
     5a. If you see a login screen, you're done!
     
     5b. If you get the same installation steps, read them carefully and make
         sure you haven't missed something. Then reload again.

When everything seems to be configured right, you will eventually see a login
page instead of the installation steps. That's it, you can start using iTwtr!


Getting help
------------

Please direct all support inquiries to @itwtr on Twitter. I will try to be as
helpful as possible. Please consider donating if you find this software useful.