GenkiYoshi

GenkiYoshi is a Ruby program to generate 原稿用紙 sheet(s) (Japanese manuscript paper) in two different "flavors": one with to-be-filled kanji and/or kana, and another with just the blank grid. This tool is great for practicing Japanese writing, whether it's kanji, kana, or mixed text.

Features

• Character Sheets: Generate 原稿用紙 sheet(s) with kana and kanji pre-filled in each cell.
• Blank Character Sheets: Generate only the blank grid, allowing freehand writing practice.
• Custom Sizes (Coming Soon): Currently supports A4 paper size. More paper sizes are on the way.

---

Table of Contents

1. Installation
2. Usage
   • Character Sheets
   • Blank Character Sheets
3. Contributing
4. Credits
5. Coming Soon

---

Installation

To start using GenkiYoshi, follow the instructions below to install Ruby and set up the project.

Step 1: Install Ruby

If you don't have Ruby installed on your system, follow the instructions below for your platform.

Windows

1. Download the Ruby Installer from RubyInstaller.
2. Run the installer and ensure you select the option to add Ruby to your system's PATH.

MacOS

1. You can install Ruby via Homebrew:

   brew install ruby

Linux

1. Install Ruby using your package manager. For example, on Ubuntu:

   sudo apt install ruby-full

Step 2: Install Required Dependencies

Install Prawn Gem

GenkiYoshi uses the prawn gem to generate PDFs. Install the gem by running the following command:

gem install prawn

Install Poppler-Utils

Poppler-utils is required for PDF processing for printing in paper. Install it based on your operating system:

Ubuntu/Debian

sudo apt-get update
sudo apt-get install poppler-utils

MacOS

brew install poppler

Windows

1. Download the latest poppler release for Windows from poppler releases
2. Extract the downloaded file
3. Add the bin directory to your system's PATH environment variable

Step 3: Clone the GenkiYoshi repository

1. Open a terminal and run the following command to clone the project:

   git clone https://github.com/FragozoLeonardo/Genki-Yoshi.git

2. Navigate to the project directory:

   cd Genki-Yoshi

---

Usage

Once Ruby is installed and the repository is cloned, you can start generating your 原稿用紙 sheet(s).

Character Sheets

To generate a 原稿用紙 sheet(s) filled with kanji and kana characters:

1. Open the kanji_sheets.rb file.
2. In the file, you will see some arrays. This is where you will input the characters you want to appear on the sheet: Example:

   kanji = %w[日本語学習]

3. Run the script in your terminal:

   ruby kanji_sheets.rb

This will generate an A4-size 原稿用紙 sheet(s) with the characters you specified in each cell.

Blank Character Sheets

If you want to generate a blank grid for freehand practice:

1. Open the kanji_sheets_blank.rb file.
2. Simply run the script:

   ruby kanji_sheets_blank.rb

This will generate a blank A4-sized 原稿用紙 sheet(s) for manual writing.

---

Credits

Nihilist.org.uk creator. - For the strokes order font.

Contributing

Feel free to contribute by submitting issues or pull requests! We're open to adding more features, improving performance, or expanding the paper size options.

Coming Soon

• Additional paper sizes (B5, A5, and more).
• Font options.
• Support for customizing the number of cells.
• Rspec tests in order to assegurate the application is working as intended.
• Improvements on the matter of OOP and Programming Principles such as SOLID.
• A web-based version with aesthetic features such as grid colour and further.

---

Happy writing with GenkiYoshi! 😊