Skip to content

Commit 70e6634

Browse files
DavidLiedleclaude
andcommitted
Add CLAUDE.md for Claude Code context
Provides guidance for future Claude Code instances working with this repository, including repository structure, content characteristics, and maintenance guidelines. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent e5070dc commit 70e6634

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CLAUDE.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Repository Purpose
6+
7+
This is a comprehensive book about the Io programming language, written entirely in Markdown. The book targets experienced programmers as a second or third language resource, focusing on prototype-based object-oriented programming concepts with comparisons to mainstream languages (JavaScript, Python, Ruby, Java).
8+
9+
## Content Structure
10+
11+
The repository contains 19 numbered chapter files (00-preface.md through 18-conclusion.md) that form a complete technical book. Each chapter builds on previous concepts while maintaining standalone value. The `examples/` directory contains runnable Io code organized by chapter.
12+
13+
## Working with Content
14+
15+
### Running Examples
16+
```bash
17+
io examples/chapter-02/hello.io
18+
```
19+
Note: The Io interpreter may not be installed on all systems. Installation:
20+
- macOS: `brew install io`
21+
- Linux: Build from source at https://github.com/IoLanguage/io
22+
- Windows: Use WSL or Docker
23+
24+
### Key Content Characteristics
25+
26+
1. **Technical Comparisons**: Examples frequently compare Io concepts to JavaScript, Python, Ruby, and Java equivalents
27+
2. **Code Examples**: All code blocks are meant to be runnable in the Io REPL
28+
3. **Benchmark Outputs**: Performance comparisons include representative timing outputs (e.g., Chapter 5 benchmarks)
29+
4. **Progressive Complexity**: Early chapters introduce fundamentals, later chapters cover advanced topics like metaprogramming and concurrency
30+
31+
## Maintenance Guidelines
32+
33+
### When Adding Content
34+
- Maintain consistent comparison style with other languages
35+
- Include runnable code examples with expected outputs
36+
- Place example files in appropriate `examples/chapter-XX/` directories
37+
- Follow the established chapter numbering scheme
38+
39+
### When Reviewing Feedback
40+
- The book has been reviewed by Steve Dekorte (Io's creator) - his feedback focused on adding outputs for benchmarks and expanding explanations for operator messages and common patterns
41+
42+
### Version Control
43+
- The repository uses semantic versioning with tags (current: v1.1.0)
44+
- Major content improvements warrant version bumps
45+
- Include acknowledgments for technical reviewers in README.md
46+
47+
## Important Context
48+
49+
This book was generated by Claude (Opus 4.1) in collaboration with a human developer. The entire 400+ page book was created in a single conversation session, demonstrating AI-assisted technical writing capabilities. The content is released under CC0 1.0 Universal license, encouraging community contributions and corrections.

0 commit comments

Comments
 (0)