Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,17 @@ m.post(x.mul(y).eq(12)); // x * y == 12
m.post(z.div(y).ne(0)); // z / y != 0
```

**Mathematical syntax with post! macro**
```
post!(m, x < y); // x < y
post!(m, y <= z); // y <= z
post!(m, z > int(5)); // z > 5
post!(m, x + y <= z); // x + y <= z
post!(m, y - x >= int(0)); // y - x >= 0
post!(m, x * y == int(12)); // x * y == 12
post!(m, z / y != int(0)); // z / y != 0
```

## Installation

Add this to your `Cargo.toml`:
Expand Down
201 changes: 151 additions & 50 deletions docs/development/HEALTH_CHECK.md

Large diffs are not rendered by default.

24 changes: 18 additions & 6 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,26 @@

This directory contains user-facing documentation and guides for using the CSP Solver library.

## 📚 Available Guides
## � **Start Here**

### **[📖 Getting Started Guide](getting_started.md)**
**Complete beginner tutorial** - Learn CSP solving from scratch with step-by-step examples, practical problems, and hands-on exercises. Perfect for first-time users!

## �📚 Available Guides

### Core Documentation
- **[getting_started.md](getting_started.md)** - 🌟 **Complete beginner tutorial with step-by-step examples**
- **[memory_management.md](memory_management.md)** - Complete memory management guide with safety features, limits, and best practices
- **[mathematical_syntax.md](mathematical_syntax.md)** - Mathematical syntax and expression documentation
- **[precision_handling.md](precision_handling.md)** - Comprehensive precision handling guide for float variables
- **[precision_quick_reference.md](precision_quick_reference.md)** - Quick reference for precision configuration

## 🎯 Guide Categories

### 🛡️ **Safety & Resource Management**
### � **Getting Started**
New to constraint solving? Start with the comprehensive tutorial that teaches you everything from basic concepts to solving real problems.

### �🛡️ **Safety & Resource Management**
Learn how to use the built-in safety features to prevent system crashes and manage resource usage effectively.

### 🧮 **Mathematical Operations**
Expand All @@ -21,11 +30,14 @@ Understand the mathematical syntax, expressions, and constraint building capabil
### 🔢 **Precision Control**
Master floating-point precision handling for accurate numerical computations.

## 🚀 Getting Started
## �️ Learning Path

**Recommended order for new users:**

1. **Start with [memory_management.md](memory_management.md)** to understand the safety features
2. **Read [mathematical_syntax.md](mathematical_syntax.md)** for constraint syntax
3. **Check [precision_handling.md](precision_handling.md)** for float variable precision
1. **[getting_started.md](getting_started.md)** - Learn the fundamentals with hands-on examples
2. **[memory_management.md](memory_management.md)** - Understand safety features and resource limits
3. **[mathematical_syntax.md](mathematical_syntax.md)** - Master advanced constraint syntax
4. **[precision_handling.md](precision_handling.md)** - Handle floating-point precision (if needed)

## 📋 Quick Links

Expand Down
Loading