Skip to content

Commit 4576ed0

Browse files
authored
Merge pull request #11 from ArkieCoder/kittysupport
update README
2 parents db435fe + 64cd7bf commit 4576ed0

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,35 @@
1-
# rubyprimer
2-
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.
1+
# Ruby Primer
32

4-
# Prerequisites
5-
- ruby
6-
- bundle
3+
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.
74

8-
# Getting Started
9-
Run the initRubyGems.sh script to download necessary Ruby gems to the local directory, then run ./rp to run the primer.
5+
## Technology Used
6+
7+
- **Language**: Ruby 3.2+
8+
- **Dependencies**:
9+
- Bundler for gem management
10+
- RSpec for testing
11+
- Ruby-Figlet for ASCII art
12+
- Colorize for colored output
13+
- **Image Generation**:
14+
- Pandoc
15+
- XeLaTeX
16+
- ImageMagick
17+
- IBM Plex Serif Light font
18+
- **Terminal Image Display**: `viu` for inline images in Kitty, built-in support for iTerm2
19+
20+
## Supported Terminals
21+
22+
- **iTerm2** on macOS
23+
- **Kitty** on macOS or Linux
24+
25+
## Prerequisites
26+
27+
- XeLaTeX (with IBM Plex Serif Light font)
28+
- ImageMagick
29+
30+
## Getting Started
31+
32+
0. Clone this repository
33+
1. Run `./install.sh` to install dependencies and set up the environment.
34+
2. Run `rp` to start the interactive Ruby lessons.
35+
3. Follow the on-screen instructions to navigate lessons and run examples/tests.

0 commit comments

Comments
 (0)