<commit_before>
This guide is also available in HTML at http://rsence.org/trac/wiki/QuickStart

INSTALLATION



1. INSTALLING SYSTEM DEPENDENCIES


1.1. Mac OS X

 - Install a recent version of [http://developer.apple.com/mac/ XCode] to get at least the gnu compiler collection.

 - Install the most recent version of [http://www.macports.org/ MacPorts]

 - Update rubygems to the most recent version, unless you do it regularly anyway:
 
---
  sudo gem update --system
  sudo gem update
---

1.1.1 Mac OS X 10.4 and 10.5

 - Install a these packages using Terminal:

---
  sudo port install ruby +thread_hooks
  sudo port install rb-rubygems
  sudo port install sqlite3-ruby
---


1.1.2 Mac OS X 10.6

 - Install a these packages using Terminal:

---
  sudo port install sqlite3
---


1.2. Debian and Ubuntu GNU Linux

 - Install these packages:

---
  sudo apt-get install build-essential ruby-full sqlite3-ruby rubygems rake
---


1.99. Unsupported UNX-like operating system
      (Applies to Linux distributions not listed above)

 You'll have to figure out how to install the dependencies on your own,
 but generally this is the list of software you should look for:

 - Ruby 1.8.7 or newer

 - Rake (ruby replacement for make)

 - Sqlite

 - Ruby Gems

 - A standard set of compilers and build tools



2. RUBY PACKAGES (RUBY GEMS)

These ruby gems are required:

 - rake (not required, if you have a system package of it installed)

 - rack

 - thin (or another rack-compatible http server library)

 - json

 - Required by persistent session storage:

   - sqlite3-ruby

   - sequel


These ruby gems are recommended. The system will run without them but manual reconfiguration might be needed.

 - cssmin

 - highline (not required, if you don't need the setup wizard)

 - soap4r (not required, if you don't need to create SOAP services)

 - rmagick (not required, but used by many projects)



2.1. Command-line installation example of the gems

---
  sudo gem install rake highline rack thin soap4r rmagick json sequel
---



3. SETTING UP A PROJECT


3.1. Create a directory for your project
This directory will contain everything needed to run your application.

---
mkdir my_riassence_project
cd my_riassence_project
mkdir conf # optional, place additional configuration files here
mkdir plugins # optional, place your local plugins here
mkdir lib # optional, place your libraries here
mkdir js # optional, create your JavaScript components here
---

<commit_msg>Installation notes for Windows.<commit_after>
This guide is also available in HTML at http://rsence.org/trac/wiki/QuickStart

INSTALLATION



1. INSTALLING SYSTEM DEPENDENCIES


1.1. Mac OS X

 - Install a recent version of [http://developer.apple.com/mac/ XCode] to get at least the gnu compiler collection.

 - Install the most recent version of [http://www.macports.org/ MacPorts]

 - Update rubygems to the most recent version, unless you do it regularly anyway:
 
---
  sudo gem update --system
  sudo gem update
---

1.1.1 Mac OS X 10.4 and 10.5

 - Install a these packages using Terminal:

---
  sudo port install ruby +thread_hooks
  sudo port install rb-rubygems
  sudo port install sqlite3-ruby
---


1.1.2 Mac OS X 10.6

 - Install a these packages using Terminal:

---
  sudo port install sqlite3
---


1.2. Debian and Ubuntu GNU Linux

 - Install these packages:

---
  sudo apt-get install build-essential ruby-full sqlite3-ruby rubygems rake
---


1.99. Unsupported UNX-like operating system
      (Applies to Linux distributions not listed above)

 You'll have to figure out how to install the dependencies on your own,
 but generally this is the list of software you should look for:

 - Ruby 1.8.7 or newer

 - Rake (ruby replacement for make)

 - Sqlite

 - Ruby Gems

 - A standard set of compilers and build tools



2. RUBY PACKAGES (RUBY GEMS)

These ruby gems are required:

 - rake (not required, if you have a system package of it installed)

 - rack

 - A rack handler, one of the following are suggested:
 
   - mongrel (solid, pretty fast works reliably)
   
   - thin (quick, but not the most reliable)
   
   - webrick (very slow; use as last resort)

 - json
 
 - yaml

 - jsmin_c (js whitespace removal)
 
 - jscompress (js namespace compression/obfuscation)
 
 - html_min (html whitespace removal)
 
 - cssmin (css whitespace removal)
 
 - Required by persistent session storage:

   - sqlite3-ruby (or other sequel -compatible database adapter)

   - sequel


These ruby gems are recommended. The system will run without them but manual reconfiguration might be needed.

 - highline (not required, if you don't need the setup wizard)

 - soap4r (not required, if you don't need to create SOAP services)

 - rmagick (not required, but used by many projects)



2.1. Command-line installation example of the gems

---
  sudo gem install rake highline rack mongrel soap4r rmagick json sequel sqlite3-ruby cssmin randgen jsmin_c jscompress html_min
---

2.2. Installation requirements for Windows
---
  
  Install ruby 1.8.7:
    - http://rubyinstaller.org/download.html
    - Follow included instructions
    - Install the Development Kit (same page)
  
  Install rmagick first from:
    - Download rmagick-win32 from http://rubyforge.org/projects/rmagick/
    - Follow included instructions
  
  Install the sqlite3.dll from:
    - Download sqlitedll from http://www.sqlite.org/download.html
    - Extract sqlite3.dll into \ruby\bin or other directory in PATH
  
  In the cmd prompt do:
    - gem install rake highline rack mongrel soap4r rmagick json sequel sqlite3-ruby cssmin randgen jsmin_c jscompress html_min
  
  Note 1: Configure http with mongrel or webrick
  Note 2: Ensure the session database string doesn't include the "C:" -part (if using sqlite)
  
---



3. SETTING UP A PROJECT


3.1. Create a directory for your project
This directory will contain everything needed to run your application.

---
mkdir my_riassence_project
cd my_riassence_project
mkdir conf # optional, place additional configuration files here
mkdir plugins # optional, place your local plugins here
mkdir lib # optional, place your libraries here
mkdir js # optional, create your JavaScript components here
---


{'fraction_non_alphanumeric': 0.06698872785829307, 'fraction_numerical': 0.014492753623188406, 'mean_word_length': 3.1406666666666667, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 3, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 5, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4580410', 'n_tokens_mistral': 1942, 'n_tokens_neox': 1721, 'n_words': 817}