<commit_before>= fumoffu

Description goes here.

I just started a month ago so the whole thing is still pretty fresh :).

== Environment

Make sure you have your JRuby environment loaded, or configure your IDE to points to your jruby installation

On a terminal
-------------
To load your JRuby environment in a terminal just make a quick export
```sh
export PATH=/your/local/path/jruby-X.X.X/bin:$PATH
```

Installation
============

New project install the gem.
Then create a new project
```sh
mkdir MyApp
cd MyApp
fumoffu -i
```

# Compile the java source and generate the jar that will contain the view

Packaging
=========

To package your application first you need to create a jar of all the bundled
```sh
bundle install lib/ruby
rake pkg:rawr:bundle_jar
rake rawr:jar
rake rawr:bundle_app
```

Then configure the rake file in config/tasks/package.rake


= Jar dependencies

swing-layout => 1.0.4
<commit_msg>Add more information in the README<commit_after># Fumoffu

<NAME> aka Bouba

http://github.com/bouba/fumoffu

I just started a month ago so the whole thing is still pretty fresh and unstable ^_^.
So I hope you will be able to enjoy it. But do not worry, I will be documenting the project progressively.

## Description

Fumoffu is a [JRuby][jruby] / Java Swing Framework which enabling users to easily design and create crossplatform desktop application.

**The framework goal primary goals are:**

* Develop a cross-platform UI (Windows, OSX, Linux)
* Easily and quickly package and deploy the application
* Easily setup the development environment

* * *

## Installation

1. **Setup your [JRuby][jruby] environment**
 
 _First download and install [JRuby][jruby] if do not have it_

 __On a terminal__

 To load your [JRuby][jruby] environment in a terminal just make a quick export

 ```sh
 export PATH=/your/local/path/jruby-X.X.X/bin:$PATH
 ```

2. **Download and setup the Fumoffu gem**

 _Since I still did put the gem on ruby forge to install it you to download and generate the gem manually to install it_

 ```sh
 git clone <EMAIL>@github.com:bouba/fumoffu.git
 cd fomuffu
 bundle install
 rake install
 cd pkg
 gem i fumoffu-0.0.1.gem --local
 ```

3. **Setup your project files**

 New project install the gem.
 Then create a new project

 ```sh
 mkdir MyApp
 cd MyApp
 fumoffu -i
 ```

4. **Setup your IDE**

 Currently this step is still in my opinion it is still way too complicated to do. For your information I use Netbeans.
 
 Here is the basic idea of how I setup my development environment.
 I create 2 Projects:

 * A Java Project
 * A Ruby Project (where I switch the compiler to JRuby and add the root folder to the sources to be able to access to my Rake tasks using my IDE)

 _I think will make a video or something regarding the IDE setup, until I script the setup._


* * *
## Packaging

To package your application first you need to create a jar of all the bundled

```sh
bundle install lib/ruby
rake pkg:rawr:bundle_jar
rake rawr:jar
rake rawr:bundle_app
```

Then configure the rake file in config/tasks/package.rake

[jruby]: http://jruby.org/download "[JRuby][jruby]"
{'fraction_non_alphanumeric': 0.08148861084376002, 'fraction_numerical': 0.003529034327879371, 'mean_word_length': 3.917981072555205, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 6, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, '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': '7259442', 'n_tokens_mistral': 975, 'n_tokens_neox': 901, 'n_words': 450}