From 896dc72606baf630c001aeb2c546cb233642639a Mon Sep 17 00:00:00 2001 From: Jason Reeves Date: Thu, 18 Dec 2025 13:51:33 -0600 Subject: [PATCH 1/2] Update README with technology info, site takedown note, and supported terminals --- README.md | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a89e33b..af7b7e3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,32 @@ -# rubyprimer -Ruby Primer is a set of interactive lessons that run in a text console, based on the excellent primer maintained by C42 Engineering at RubyMonk.com. +# Ruby Primer -# Prerequisites -- ruby -- bundle +Ruby Primer is a set of interactive lessons that run in a text console. It was originally based on the excellent primer maintained by C42 Engineering at RubyMonk.com, but that site was taken down earlier this year. The lessons have been preserved and enhanced here. -# Getting Started -Run the initRubyGems.sh script to download necessary Ruby gems to the local directory, then run ./rp to run the primer. +## Technology Used + +- **Language**: Ruby 3.2+ +- **Dependencies**: Bundler for gem management, RSpec for testing, Ruby-Figlet for ASCII art, Colorize for colored output +- **Image Generation**: Pandoc and XeLaTeX for PDF creation from Markdown, ImageMagick for PNG conversion +- **Terminal Image Display**: viu for inline images in Kitty, built-in support for iTerm2 +- **Build Tools**: GitHub Actions for CI (Ruby and JSON syntax checks) + +## Supported Terminals + +- **iTerm2** on macOS (displays formatted text as PDF images) +- **Kitty** on macOS or Linux (displays formatted text as PNG images via viu) + +## Prerequisites + +- Ruby 3.2 or higher +- Bundler +- Pandoc +- XeLaTeX (with IBM Plex Serif Light font) +- ImageMagick +- viu (for Kitty support) +- Terminal with at least 135 columns x 40 rows + +## Getting Started + +1. Run `./install.sh` to install dependencies and set up the environment. +2. Run `./rp` to start the interactive Ruby lessons. +3. Follow the on-screen instructions to navigate lessons and run examples/tests. From 64cd7bf59894b720428f75187cffc6e16b5bc485 Mon Sep 17 00:00:00 2001 From: Jason Reeves Date: Thu, 18 Dec 2025 13:56:43 -0600 Subject: [PATCH 2/2] update README --- README.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index af7b7e3..f20f9d0 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,35 @@ # Ruby Primer -Ruby Primer is a set of interactive lessons that run in a text console. It was originally based on the excellent primer maintained by C42 Engineering at RubyMonk.com, but that site was taken down earlier this year. The lessons have been preserved and enhanced here. +Ruby Primer is a set of interactive lessons that run in a text console. It was originally based on the excellent primer maintained by C42 Engineering at RubyMonk.com, but that site was taken down in 2025. The lessons have been preserved here. ## Technology Used - **Language**: Ruby 3.2+ -- **Dependencies**: Bundler for gem management, RSpec for testing, Ruby-Figlet for ASCII art, Colorize for colored output -- **Image Generation**: Pandoc and XeLaTeX for PDF creation from Markdown, ImageMagick for PNG conversion -- **Terminal Image Display**: viu for inline images in Kitty, built-in support for iTerm2 -- **Build Tools**: GitHub Actions for CI (Ruby and JSON syntax checks) +- **Dependencies**: + - Bundler for gem management + - RSpec for testing + - Ruby-Figlet for ASCII art + - Colorize for colored output +- **Image Generation**: + - Pandoc + - XeLaTeX + - ImageMagick + - IBM Plex Serif Light font +- **Terminal Image Display**: `viu` for inline images in Kitty, built-in support for iTerm2 ## Supported Terminals -- **iTerm2** on macOS (displays formatted text as PDF images) -- **Kitty** on macOS or Linux (displays formatted text as PNG images via viu) +- **iTerm2** on macOS +- **Kitty** on macOS or Linux ## Prerequisites -- Ruby 3.2 or higher -- Bundler -- Pandoc - XeLaTeX (with IBM Plex Serif Light font) - ImageMagick -- viu (for Kitty support) -- Terminal with at least 135 columns x 40 rows ## Getting Started +0. Clone this repository 1. Run `./install.sh` to install dependencies and set up the environment. -2. Run `./rp` to start the interactive Ruby lessons. +2. Run `rp` to start the interactive Ruby lessons. 3. Follow the on-screen instructions to navigate lessons and run examples/tests.