https://github.com/prikhi/genkouyoushi-generator

Haskell Library, CLI App, & API Server for Generating Genkouyoushi(原稿用紙) Paper
https://github.com/prikhi/genkouyoushi-generator

cli diagram generator genkouyoushi genkouyoushi-generator haskell haskell-cli japanese-study paper servant

Last synced: about 6 hours ago
JSON representation

Haskell Library, CLI App, & API Server for Generating Genkouyoushi(原稿用紙) Paper

• Host: GitHub
• URL: https://github.com/prikhi/genkouyoushi-generator
• Owner: prikhi
• License: gpl-3.0
• Created: 2019-10-01T03:40:29.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-08T20:57:43.000Z (about 5 years ago)
• Last Synced: 2024-10-11T23:22:15.713Z (about 1 month ago)
• Topics: cli, diagram, generator, genkouyoushi, genkouyoushi-generator, haskell, haskell-cli, japanese-study, paper, servant
• Language: Haskell
• Homepage:
• Size: 29.3 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Genkouyoushi Paper Generator

[![Genkouyoushi Generator Build Status](https://travis-ci.org/prikhi/genkouyoushi-generator.svg?branch=master)](https://travis-ci.org/prikhi/genkouyoushi-generator)

A library, command line program, and web server to generate various formats of

genkoyoushi paper for practicing your Kana/Kanji.

The CLI program may be passed arguments to customize the page size, margins,

box count(rows/columns), presence of Furigana boxes, etc. Output formats

include PNG, JPG, & PDF.

The API server accepts configuration parameters via JSON and replies with a

bytestring of the generated PDF file.

## Build / Run

You'll need

[stack](https://docs.haskellstack.org/en/stable/README/#how-to-install)

installed. Then you can build & run the CLI program:

```sh 

stack build

stack run genkouyoushi-gen test.png

feh test.png

```

Run `stack run genkouyoushi-gen -- --help` to see a full list of arguments that

can be used to customize the generated paper.

Run `stack install genkouyoushi-generator:exe:genkouyoushi-gen` to build & copy

the `genkouyoushi-gen` executable to `~/.local/bin`. Running `stack install`

without any arguments will copy both the CLI program and API server.

## API Server

A simple web service is provided with the `genkouyoushi-api` executable. This

accepts JSON POST requests for the `Genkouyoushi.Config` type and replies with

a bytestring containing a generated PDF. A webapp to interact with the API

server will also be added to this repository.

## License

GPL-v3.0+