@devaloop/devalang 0.0.1-alpha.8 → 0.0.1-beta.1

package/templates/minimal/README.md

@@ -1,192 +1,204 @@
 <div align="center">
-    <img src="https://firebasestorage.googleapis.com/v0/b/devaloop-labs.firebasestorage.app/o/devalang-teal-logo.svg?alt=media&token=d2a5705a-1eba-4b49-88e6-895a761fb7f7" alt="Devalang Logo">
+    <img src="https://devalang.com/images/devalang-logo-min.png" alt="Devalang Logo" width="100" />
 </div>
 
 ![Rust](https://img.shields.io/badge/Made%20with-Rust-orange?logo=rust)
 ![TypeScript](https://img.shields.io/badge/Built%20with-TypeScript-blue?logo=typescript)
 ![Node.js](https://img.shields.io/badge/Node.js-18%2B-brightgreen?logo=node.js)
 
-![Project Status](https://img.shields.io/badge/status-alpha-red)
-![Version](https://img.shields.io/badge/version-0.0.1-blue)
+![Project Status](https://img.shields.io/badge/status-beta-blue)
+![Version](https://img.shields.io/npm/v/@devaloop/devalang)
 ![License: MIT](https://img.shields.io/badge/license-MIT-green)
-![Platform](https://img.shields.io/badge/platform-Windows-blue)
+
+![Linux](https://img.shields.io/badge/linux-supported-blue?logo=linux)
+![macOS](https://img.shields.io/badge/macOS-supported-blue?logo=apple)
+![Windows](https://img.shields.io/badge/windows-supported-blue?logo=windows)
 
 ![npm](https://img.shields.io/npm/dt/@devaloop/devalang)
 ![crates](https://img.shields.io/crates/d/devalang)
 
-## 🎼 Devalang, by **Devaloop Labs**
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/devaloop-labs/devalang/.github/workflows/ci.yml)
 
-🎶 Compose music with code — simple, structured, sonic.
+# 🦊 Devalang (CORE) — Compose music with code
 
 Devalang is a tiny domain-specific language (DSL) for music makers, sound designers, and audio hackers.
 Compose loops, control samples, render and play audio — all in clean, readable text.
 
-🦊 Whether you're building a track, shaping textures, or performing live, Devalang helps you think in rhythms. It’s designed to be simple, expressive, and fast — because your ideas shouldn’t wait.
+Whether you're building a track, shaping textures, or performing live, Devalang helps you think in rhythms. It’s designed to be simple, expressive, and fast — because your ideas shouldn’t wait.
 
 From studio sketches to live sets, Devalang gives you rhythmic control — with the elegance of code.
 
-> 🚧 **v0.0.1-alpha.5 Notice** 🚧
+> **🚧 Notice 🚧**
 >
-> Currently, Devalang CLI is only available for **Windows**.  
-> Linux and macOS binaries will be added in future releases via cross-platform builds.
-
----
+> Includes synthesis, playback, and rendering features, but is still in early development, and breaking changes may occur.
+>
+> **NEW**: [Devaforge is now available for creating addons](https://github.com/devaloop-labs/devaforge).
+>
+> **NEW**: Now available for Windows, Linux, and macOS.
 
 ## 📚 Quick Access
 
-- [📖 Documentation](./docs/)
+- [▶️ Playground](https://playground.devalang.com)
+- [📖 Documentation](https://docs.devalang.com)
+- [🧩 VSCode Extension](https://marketplace.visualstudio.com/items?itemName=devaloop.devalang-vscode)
+- [🎨 Prettier Plugin](https://www.npmjs.com/package/@devaloop/prettier-plugin-devalang)
+- [📜 Changelog](./docs/CHANGELOG.md)
 - [💡 Examples](./examples/)
 - [🌐 Project Website](https://devalang.com)
+- [📦 Devaforge on npm](https://www.npmjs.com/package/@devaloop/devaforge)
+- [📦 Devalang on npm](https://www.npmjs.com/package/@devaloop/devalang)
 
-## 🚀 Features
-
-- 🎵 **Audio Engine**: Integrated audio playback and rendering
-- 🧩 **Module system** for importing and exporting variables between files
-- 📜 **Structured AST** generation for debugging and future compilation
-- 🔢 **Basic data types**: strings, numbers, booleans, maps, arrays
-- 👁️ **Watch mode** for `build`, `check` and `play` commands
-- 📂 **Project templates** for quick setup
+## ⏱️ Try it now !
 
-## 📆 Installation
+### Try Devalang in your browser
 
-### For users
+> [Have a look at the Playground to try Devalang directly in your browser](https://playground.devalang.com)
 
-> - ⚠️ Requires [Node.js 18+](https://nodejs.org/en/download)
+### Try Devalang in your terminal
 
-Install the package globally (NPM)
+#### With Node.js
 
 ```bash
-npm install -g @devaloop/devalang
+npm install -g @devaloop/devalang@latest
 ```
 
-Usage without install (NPX)
+#### With Rust
 
 ```bash
-npx @devaloop/devalang <command>
+cargo install devalang
 ```
 
-### For contributors
-
-> - ⚠️ Requires [Node.js 18+](https://nodejs.org/en/download)
-> - ⚠️ Requires [Rust 1.70+](https://www.rust-lang.org/learn/get-started#installing-rust)
+#### Initialize a new project
 
 ```bash
-> git clone https://github.com/devaloop-labs/devalang.git
-> cd devalang
-> npm install
-> cargo install --path .
+devalang init --name my-project --template minimal
 ```
 
-Development usage (you can customize arguments in package.json)
-
-```bash
-# For syntax checking test
-npm run rust:dev:check
-# For building test
-npm run rust:dev:build
-```
-
-## ❔ Usage
-
-NOTE: Commands are available via `devalang` or `npx @devaloop/devalang`.
-
-NOTE: Arguments can be passed to commands using `--<argument>` syntax. You can also use a configuration file to set default values for various settings, making it easier to manage your Devalang project.
+#### Write your first script
 
-NOTE: Some commands require a mandatory `--entry` argument to specify the input folder, and a `--output` argument to specify the output folder. If not specified, they default to `./src` and `./output` respectively.
+Create a new Devalang file `src/index.deva` in the project directory:
 
-For more examples, see [docs/COMMANDS.md](./docs/COMMANDS.md)
-
-### Initialize a new project
-
-In the current directory
-
-```bash
-devalang init
-```
-
-Or use optional arguments to specify a directory name and a template
-
-```bash
-devalang init --name <project-name> --template <template-name>
-```
-
-### Checking syntax only
-
-```bash
-devalang check --watch
+```deva
+# src/index.deva
+
+# BPM definition
+bpm 125
+
+# Bank picking (make sure you've installed it)
+bank devaloop.808 as my808Bank
+
+# Pattern literal without options
+pattern kickPattern with my808Bank.kick = "x--- x--- x--- x---"
+
+group myGroup:
+    # Rhythmic (each beat playing a kick)
+    # on beat:
+    #     .my808Bank.kick 1/4
+
+    # Synth definition with ADSR
+    let myLead = synth sine {
+        attack: 0,
+        decay: 100,
+        sustain: 100,
+        release: 100
+    }
+
+    # Global automation
+    automate myLead:
+        param volume {
+            0% = 0.0
+            100% = 0.5
+        }
+        param pitch {
+            0% = -12.0
+            100% = 12.0
+        }
+
+    # Notes in a loop with condition
+    for i in [1, 2, 3]:
+        if i == 3:
+            myLead -> note(C5, { duration: 200 })
+            print "Playing note C5 for " + i
+
+    # Pause runtime for 500ms
+    sleep 500
+
+    # Note with automation
+    myLead -> note(C4, {
+        duration: 400,
+        velocity: 0.8,
+        automate: {
+            pan: {
+                0%: -1.0,
+                100%: 0.0
+            }
+        }
+    })
+
+    # Notes with params
+    myLead -> note(G4, { duration: 600, glide: true, target_freq: 659.25 })
+    myLead -> note(B3, { duration: 400, slide: true, target_amp: 0.3 })
+
+# Spawning the group & the pattern to play them in parallel
+spawn myGroup
+spawn kickPattern
 ```
 
-### Building output files
-
-```bash
-devalang build --watch
-```
+### And the best part ? You can play it directly from the command line:
 
-### Playing audio files (once by file change)
+#### Play the script once
 
 ```bash
-devalang play --watch
+devalang play
 ```
 
-### Playing audio files (continuous playback, even without file changes)
+#### **LIVE mode** (repeat the playback + watch mode)
 
 ```bash
 devalang play --repeat
 ```
 
-## ⚙️ Configuration
+### 🎉 You can now hear your Devalang code in action
 
-You can use a configuration file to set default values for various settings, making it easier to manage your Devalang project.
+> For more examples, check out the [examples directory](./examples/)
 
-To do this, create a `.devalang` file in the root of your project directory.
+## ❓ Why Devalang ?
 
-See [docs/CONFIG.md](./docs/CONFIG.md) for more information.
+- 🎹 Prototype audio ideas without opening a DAW, even VSCode with our Playground
+- 💻 Integrate sound into code-based workflows
+- 🎛️ Control audio parameters through readable syntax
+- 🧪 Build musical logic with variables and conditions
+- 🔄 Create complex patterns with ease
 
-## 📄 Syntax example
-
-For more examples, see [docs/SYNTAX.md](./docs/SYNTAX.md)
-
-```deva
-# index.deva
-
-@import { globalBpm, globalBank, kickDuration } from "global.deva"
-
-@load "./examples/samples/kick-808.wav" as customKick
-
-bpm globalBpm
-# Will declare the tempo at the globalBpm variable beats per minute
-
-bank globalBank
-# Will declare a custom instrument bank using the globalBank variable
-
-loop 5:
-    .customKick kickDuration {reverb=50, drive=25}
-    # Will play 5 times a kick for the duration of the kickDuration variable with reverb and drive effects
-```
-
-```deva
-# global.deva
-
-let globalBpm = 120
-let globalBank = 808
-let kickDuration = 500
-
-@export { globalBpm, globalBank, kickDuration }
-```
-
-## 🧯 Known issues
-
-- No support yet for `if`, `else`, `else if` statements
-- No support yet for `@group`, `@pattern`, `@function` statements
-- No support yet for cross-platform builds (Linux, macOS)
-
-## 🧪 Roadmap Highlights
-
-For more info, see [docs/ROADMAP.md](./docs/ROADMAP.md)
+## 🚀 Features
 
-- ⏳ Other statements (e.g `if`, `@group`, ...)
-- ⏳ Cross-platform support (Linux, macOS)
-- ⏳ More built-in instruments (e.g. snare, hi-hat, etc.)
+- ⚡ **Fast Build & Hot Reload** — optimized build process for quicker iteration.
+- 🎵 **Audio Engine & Real-time runner** — low-latency playback, render-to-file, and a realtime runner used by `devalang play` for live feedback.
+- ▶️ **Live mode (watch + repeat)** — edit and hear changes instantly with `devalang play --repeat` and watch mode.
+- 🧩 **Language primitives** — synths, notes, ADSR, maps, arrays, loops, conditionals and functions for expressive musical logic.
+- 🎛️ **Per-note automation & modulators** — `automate` maps, `$mod.*`, `$easing.*` and `$math.*` helpers for envelopes and LFOs.
+- 🧩 **Module system & structured AST** — import/export variables, stable AST output for debugging and tooling.
+- 🧰 **Plugins & Addons (WASM-ready)** — install plugins/banks, `@use` directive, and WASM plugin integration so plugins can render or process audio at runtime.
+- 📦 **Addon manager & Devaforge** — CLI commands to discover/install banks, plugins and templates; `devaforge` helps create addons.
+- ⚙️ **CLI tooling** — `build`, `check`, `play`, `install`, `init`, `discover`, `telemetry` and more with consistent flags (`--watch`, `--debug`, `--compress`).
+- 📂 **Project templates & examples** — quick-start templates and many example projects in `examples/`.
+- 🧑‍💻 **TypeScript API & WASM distribution** — Node-friendly package with TypeScript bindings and a WASM build for browser/Node usage.
+- 🧰 **Editor & formatting support** — VSCode extension and Prettier plugin to edit Devalang with syntax and formatting support.
+- 🎵 **Custom samples & banks** — drop samples into `.deva` and reference them from code; banks of sounds for fast composition.
+- 🔄 **Looping, grouping & scheduling** — precise beat-tied scheduling primitives for complex rhythmic patterns.
+
+## 📄 Documentation
+
+### [Please refer to the online documentation](https://docs.devalang.com) for detailed information on syntax, features, and usage examples
+
+## 📰 What's new
+
+- **Devaforge**: Introduced a new system for creating and managing addons, including a CLI for addon generation.
+- **Documentation updates**: Improved documentation for clarity and completeness.
+- **Discovering addons**: Introduced a new command to detect addons.
+- **Public TypeScript API**: Added a public TypeScript API for easier integration.
+- **Improved error messages**: Enhanced error messages for better debugging.
+- **Bug fixes**: Various bug fixes and stability improvements.
 
 ## 🛡️ License
 
@@ -197,6 +209,10 @@ MIT — see [LICENSE](./LICENSE)
 Contributions, bug reports and suggestions are welcome !  
 Feel free to open an issue or submit a pull request.
 
+For more info, see [docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md).
+
 ## 📢 Contact
 
+Feel free to reach out for any inquiries or feedback.
+
 📧 [contact@devaloop.com](mailto:contact@devaloop.com)