Ruby Application Template

Fri 2025/02/14 Ruby ruby / cross-platform / template

Overview

• installation: see https://arrizza.com/setup-common.html

Summary

This is a template for a Ruby application. It contains a set of scripts and configuration files that make creating, developing and maintaining a Ruby app easier.

• See Quick Start for information on using scripts.
• See xplat.cfg to configure xplat.cfg file.
• See xplat-utils submodule for information on the submodule.

How to use

• create a git for your app
• use a diff tool like meld, and copy contents from this repo into your app.
• Use the contents of lib as a starting point or replace completely with your app's content

Scripts

# clean it
./do_clean # start from scratch

# install it
./do_subm_update full # first time for submodules
./do_subm_update      # ... thereafter
./do_install full     # first time for OS and gems
./do_install          # ...thereafter

# doc it
./do_doc # generate yardoc html and PDF

# check it
./do_check # check configs and files are okay
./do_lint  # rubocop

# run it
./doit   # run the app/sample code
./do_ver # run verification (if implemented)
./do_ut  # run unit tests (if implemented)