Skip to content

docs: update README with project overview #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
logbie merged 1 commit into from
Feb 17, 2025
Merged

docs: update README with project overview #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 28 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
# wfl
# WFL (WebFirst Language)

## TL;DR
WFL is a programming language designed to be readable and intuitive, using natural language constructs instead of special characters and symbols. It aims to lower the barriers to entry for beginners while providing powerful features for experienced developers.

### Key Features
- Natural language-like syntax
- Minimal use of special characters
- Strong type safety
- Modern features including async operations and pattern matching
- Clear and actionable error messages

### Project Structure
- `src/` - Source code for the WFL compiler/interpreter
- `benches/` - Performance benchmarks
- Documentation:
- `wfl spec.md` - Complete language specification
- `wfl todo.md` - Development roadmap
- `wfl.md` - Additional documentation

### Built With
- Rust
- logos (lexical analysis)
- chumsky (parsing)
- thiserror & anyhow (error handling)

## More Information
For a comprehensive understanding of WFL's syntax, features, and design principles, please refer to `wfl spec.md` in this repository.