Skip to content

Commit 0e3b6c3

Browse files
Add README.md for Origami Instructions Guide - Issue sumanth-0#615
Added comprehensive README documentation including description, features, available designs, usage instructions, examples, and tips for success. This completes the documentation requirement for the Origami Instructions Guide project.
1 parent 4b3504c commit 0e3b6c3

1 file changed

Lines changed: 95 additions & 0 deletions

File tree

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Origami Instructions Guide
2+
3+
A Python script that provides step-by-step origami folding instructions from a preset selection of classic designs.
4+
5+
## Description
6+
7+
This interactive command-line program guides users through the art of origami (paper folding) with detailed step-by-step instructions. The script includes four popular origami designs with varying difficulty levels, making it perfect for beginners and intermediate folders alike.
8+
9+
## Features
10+
11+
- **4 Origami Designs**: Traditional Crane, Paper Boat, Jumping Frog, and Simple Butterfly
12+
- **Difficulty Levels**: Each design is labeled with its difficulty level (Easy or Intermediate)
13+
- **Interactive Instructions**: Step-by-step guidance with the ability to advance at your own pace
14+
- **User-Friendly Menu**: Easy-to-navigate menu system for selecting designs
15+
- **Exactly 100 Lines**: Adheres to the repository's 100-line code requirement
16+
17+
## Available Designs
18+
19+
1. **Traditional Crane** (Intermediate)
20+
- The iconic Japanese origami design
21+
- 12 detailed steps
22+
23+
2. **Paper Boat** (Easy)
24+
- A classic childhood favorite
25+
- 10 easy-to-follow steps
26+
27+
3. **Jumping Frog** (Easy)
28+
- A fun interactive origami that actually jumps!
29+
- 10 steps with a playful result
30+
31+
4. **Simple Butterfly** (Easy)
32+
- A beautiful and quick design
33+
- 8 simple steps
34+
35+
## Requirements
36+
37+
- Python 3.x
38+
- No external dependencies required
39+
40+
## Usage
41+
42+
Run the script using Python:
43+
44+
```bash
45+
python origami_instructions_guide.py
46+
```
47+
48+
Follow the on-screen menu:
49+
1. Select a design by entering its number (1-4)
50+
2. Press Enter to advance through each step
51+
3. Follow the instructions carefully
52+
4. Enter 0 to exit the program
53+
54+
## Example
55+
56+
```
57+
=== ORIGAMI INSTRUCTIONS GUIDE ===
58+
59+
Available Origami Designs:
60+
1. Traditional Crane - Difficulty: Intermediate
61+
2. Paper Boat - Difficulty: Easy
62+
3. Jumping Frog - Difficulty: Easy
63+
4. Simple Butterfly - Difficulty: Easy
64+
0. Exit
65+
66+
Select an origami design (0-4): 2
67+
68+
==================================================
69+
PAPER BOAT
70+
Difficulty Level: Easy
71+
==================================================
72+
73+
Step 1: Start with a rectangular piece of paper
74+
75+
Press Enter for next step...
76+
```
77+
78+
## Tips for Success
79+
80+
- Use square paper for best results (except the boat which uses rectangular paper)
81+
- Make crisp, sharp folds
82+
- Take your time with each step
83+
- Practice makes perfect!
84+
85+
## Contributing
86+
87+
This project is part of the 100LinesOfPythonCode repository. Contributions and improvements are welcome!
88+
89+
## Issue Reference
90+
91+
This implementation addresses issue #615: Make Origami Instructions Guide
92+
93+
## License
94+
95+
This project is open source and available under the repository's license terms.

0 commit comments

Comments
 (0)