Skip to content

Latest commit

 

History

History
54 lines (47 loc) · 2.57 KB

readme.md

File metadata and controls

54 lines (47 loc) · 2.57 KB
Raw

Grammark

A complete web application for identifying writing problems and offering suggestions.

Requirements

To run Grammark, you need to have access to a webserver (or the equivalent on your local computer) with PHP and MySQL installed, and a basic knowledge of how to use them. The download includes installation and configuration instructions. If you are completely new to this, try reading http://www.sitepoint.com/php-amp-mysql-1-installation/

Dependencies

  • Foundation CSS/JS library (automatically included by default via cdnjs.cloudflare.com)
  • Composer (dependency manager)
  • A server running PHP 5.3 or higher

Installation

  1. Place the files contained in this distribution on a webserver. Navigating to the location (e.g., mysite.com/grammark) will render the site, but without the text processing.
  2. Create a new SQL database, with username and password
  3. Import the SQL database file zipped here, grammark_grammar.sql, into that database
  4. Copy example.settings.php as a new file, "settings.php".
  5. In settings.php, enter the username, password, and database name created above. Specifically, replace the uppercase items shown below:
  • define('HOST',''); // usually localhost
  • define('USERNAME','');
  • define('PASSWORD','');
  • define('DB_NAME','');
  • define('EMAIL',''); // for the contact and database suggestion forms
  • define('ANALYTICS',''); // place Google Analytics tracking code here
  • define('TESTING_MODE', false); // true runs and displays unit tests

If you've followed the steps above, going to "mysite.com/grammark" will give you a fully-functioning grammark checker.

License

This software is protected under the GNU General Public License You may use it, provided that any modifications you make to it are available for others to use and modify in a similar manner.

Versions

Release Short Description
Grammark 3.0 Twig templating and class-based PHP
Grammark 2.0 Foundation-based CSS with better directory structure and settings files
Grammark 1.0 Custom CSS with flat file structure