diff options
Diffstat (limited to 'js/scripting-lang/baba-yaga-c/README.md')
-rw-r--r-- | js/scripting-lang/baba-yaga-c/README.md | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/js/scripting-lang/baba-yaga-c/README.md b/js/scripting-lang/baba-yaga-c/README.md new file mode 100644 index 0000000..dff97e5 --- /dev/null +++ b/js/scripting-lang/baba-yaga-c/README.md @@ -0,0 +1,69 @@ +# Baba Yaga C Implementation + +A C implementation of the Baba Yaga functional programming language. + +## Current Status + +✅ **Core Functionality Complete** - Basic language features working +**Progress**: ~85% Complete + +## Quick Start + +```bash +# Build +make debug + +# Test basic functionality +./bin/baba-yaga '5 + 3;' # Output: 8 +./bin/baba-yaga 'add 5 3;' # Output: 8 +./bin/baba-yaga '@multiply 2 3;' # Output: 6 +./bin/baba-yaga 'add 5 @multiply 3 4;' # Output: 17 +``` + +## Documentation + +📖 **[IMPLEMENTATION_GUIDE.md](IMPLEMENTATION_GUIDE.md)** - Complete implementation guide, project status, and TODO + +This unified document contains: +- Language overview and features +- Current implementation status +- Working features and examples +- Known limitations +- Development workflow +- Build system documentation +- Success metrics and risk assessment + +## Language Features + +- ✅ Basic arithmetic operations +- ✅ Function calls and references (@ operator) +- ✅ Variable assignment and lookup +- ✅ Standard library functions +- ✅ Comparison and logical operators +- 🔵 User-defined functions (in progress) +- 🔵 Pattern matching (planned) +- 🔵 Multiple statement parsing (planned) + +## Build System + +```bash +make debug # Build with debug info +make release # Build optimized version +make clean # Clean build artifacts +``` + +## Testing + +```bash +# Test basic operations +./bin/baba-yaga '5 + 3;' +./bin/baba-yaga 'add 5 3;' +./bin/baba-yaga '@multiply 2 3;' + +# Check for memory leaks +valgrind --leak-check=full ./bin/baba-yaga '5 + 3;' +``` + +## License + +[License information here] \ No newline at end of file |