Skip to content

Commit 9214b9e

Browse files
mateusmoutinhomateusmoutinho
committed
att
1 parent 63d0bb7 commit 9214b9e

File tree

1 file changed

+68
-65
lines changed

1 file changed

+68
-65
lines changed

‎README.md‎

Lines changed: 68 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,103 @@
1-
# VibeScript
2-
31
<div align="center">
42

5-
[![License: MIT](https://img.shields.io/badge/License-Unlicense-yellow.svg)](https://opensource.org/licenses/MIT)
6-
[![GitHub release](https://img.shields.io/github/release/OUIsolutions/VibeScript.svg)](https://github.com/OUIsolutions/VibeScript/releases/)
7-
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)]()
8-
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/OUIsolutions/VibeScript/pulls)
3+
# VibeScript
4+
![Lua Logo](https://img.shields.io/badge/VibeScript-0.32.0-blue?style=for-the-badge&logo=lua)
5+
[![GitHub Release](https://img.shields.io/github/release/OUIsolutions/VibeScript.svg?style=for-the-badge)](https://github.com/OUIsolutions/VibeScript/releases)
6+
[![License](https://img.shields.io/badge/License-Unlicense-green.svg?style=for-the-badge)](https://github.com/OUIsolutions/VibeScript/blob/main/LICENSE)
7+
![Status](https://img.shields.io/badge/Status-Stable-brightgreen?style=for-the-badge)
8+
![Platforms](https://img.shields.io/badge/Platforms-Windows%20|%20Linux%20|%20macOS-lightgrey?style=for-the-badge)
99

10-
**A custom Lua runtime for rapid LLM-powered automations**
10+
</div>
1111

12-
[Features](#features) • [Installation](#installation) • [Quick Start](#quick-start) • [Documentation](#documentation) • [Releases](#releases) • [License](#license)
12+
---
1313

14-
</div>
14+
### Overview
15+
16+
VibeScript is a specialized Lua runtime environment designed for LLM-powered automations. It transforms Lua scripts into powerful AI-driven workflows with seamless integration of Large Language Model capabilities:
1517

16-
## 📋 Overview
18+
1. **Configure your LLM model**
19+
2. **Write Lua automation scripts**
20+
3. **Execute AI-powered workflows**
1721

18-
VibeScript is a specialized Lua runtime environment designed to facilitate fast automations through quick scripts. It seamlessly integrates LLM capabilities into Lua, enabling powerful AI-driven workflows with minimal setup.
22+
This runtime is designed for developers who need to:
23+
- Create intelligent automation scripts with LLM integration
24+
- Perform file system operations with AI assistance
25+
- Build rapid prototypes for AI-driven applications
26+
- Deploy cross-platform automation tools
1927

20-
## ✨ Features
28+
### Key Features
2129

2230
- **LLM Integration** - Direct access to LLM models from Lua scripts
23-
- **File System Operations** - Secure read/write capabilities for automation
24-
- **Multi-platform Support** - Works on Linux, Windows, and macOS
31+
- **Multi-platform support** - Run on Windows, Linux, and macOS
32+
- **File system operations** - Secure read/write capabilities for automation
33+
- **Zero dependencies** - Standalone executables with embedded runtime
2534
- **Simple API** - Intuitive Lua interface for complex LLM operations
26-
- **Configurable Models** - Support for various LLM providers
35+
- **Configurable models** - Support for various LLM providers
2736

28-
## 🚀 Installation
2937

30-
### Run These to install on Linux:
38+
### Linux Installation
3139
```bash
3240
curl -L https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/vibescript.out -o vibescript.out && chmod +x vibescript.out && sudo mv vibescript.out /usr/local/bin/vibescript
3341
```
3442

35-
## 🏁 Quick Start
36-
37-
### 1. Configure an LLM Model
38-
43+
### macOS Installation
3944
```bash
40-
vibescript configure_model --model grok-2-latest --url https://api.x.ai/v1/chat/completions --key "your key"
45+
curl -L https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/vibescript.c -o vibescript.c && gcc vibescript.c -o vibescript && sudo mv vibescript /usr/local/bin/vibescript && rm vibescript.c
4146
```
4247

43-
See [CLI usage documentation](/docs/cli_usage.md) for more options.
48+
### Windows Installation
49+
Download the appropriate executable from the releases section below.
4450

45-
### 2. Create Your First Script
51+
### AI/LLM Integration
4652

47-
Create a file named `main.lua` with the following content:
53+
Want to learn how to use VibeScript with AI assistance? The built-in help system provides interactive examples for LLM integration and automation scripting.
4854

49-
```lua
50-
llm = newLLM({
51-
read = true,
52-
write = true,
53-
execute = true,
54-
delete = true,
55-
list = true
56-
})
57-
llm.add_user_prompt("list the src dir, and explain what's inside")
58-
response = llm.generate()
59-
print("Response: " .. response)
60-
```
55+
---
6156

62-
### 3. Run Your Script
57+
## Releases
6358

64-
```bash
65-
vibescript main.lua
66-
```
6759

68-
Explore the [Native API documentation](/docs/native_api.md) to learn more about VibeScript's capabilities.
60+
| **File** | **What is** |
61+
|---------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
62+
|[amalgamation.c](release/amalgamation.c) | Amalgamated source code containing all libraries |
63+
|[vibescript.out](release/vibescript.out) | Ready-to-use Linux binary |
64+
|[vibescripti32.exe](release/vibescripti32.exe) | Ready-to-use Windows 32-bit executable |
65+
|[vibescript.deb](release/vibescript.deb) | Debian package for easy installation |
66+
|[vibescript.rpm](release/vibescript.rpm) | RPM package for easy installation |
67+
6968

70-
## 📦 Releases
7169

72-
| File | Description |
73-
| --- | --- |
74-
| [vibescript.c](https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/VibeScript.c) | Amalgamated source code |
75-
| [vibescript.deb](https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/VibeScript.deb) | Debian Package |
76-
| [vibescript.rpm](https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/VibeScript.rpm) | RPM Package |
77-
| [vibescript.out](https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/VibeScript.out) | Linux Executable |
78-
| [vibescript64.exe](https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/VibeScript64.exe) | Windows 64-bit Executable |
79-
| [vibescripti32.exe](https://github.com/OUIsolutions/VibeScript/releases/download/0.32.0/VibeScripti32.exe) | Windows 32-bit Executable |
70+
## Documentation
8071

81-
## 📚 Documentation
72+
### CLI Usage
73+
| **Document** | **Description** |
74+
|-----------------------------------------------------------------|---------------------------------------------------------|
75+
| [Extras](docs/cli_usage/extras.md) | Additional CLI features and utilities |
76+
| [Interpreting](docs/cli_usage/interpreting.md) | Script interpretation and execution |
77+
| [LLM Operations](docs/cli_usage/llm_operations.md) | LLM model management and configuration |
78+
| [Script Memorizing](docs/cli_usage/script_memorizing.md) | Script storage and management system |
8279

83-
| Document | Description |
84-
| --- | --- |
85-
| [Native API](/docs/native_api.md) | LLM creation and usage examples |
86-
| [CLI Usage](/docs/cli_usage.md) | Command line interface reference |
87-
| [Build Instructions](/docs/build_instructions.md) | Build requirements and commands |
88-
| [Build with Extensions](/docs/build_with_extension.md) | How to add extension inside vibescript runtime|
89-
| [Build Toolchain](/docs/build_toolchain.md) | Build process and dependencies |
90-
| [Project Workflow](/docs/project_workflow.md) | Project Workflow Explanation |
91-
| [Build Workflow](/docs/build_workflow.md) | Build Workflow Explanation |
92-
| [Licenses](/docs/licenses.md) | List of licenses and copyrights |
80+
### Installation and Build
81+
| **Document** | **Description** |
82+
|-----------------------------------------------------------------|---------------------------------------------------------|
83+
| [Build Instructions](docs/install_and_build/build_instructions.md) | Build requirements and commands |
84+
| [Build with Extension](docs/install_and_build/build_with_extension.md) | How to add extensions inside VibeScript runtime |
85+
| [Install](docs/install_and_build/install.md) | Installation guide for all platforms |
9386

94-
## 🤝 Contributing
87+
### Native API
88+
| **Document** | **Description** |
89+
|-----------------------------------------------------------------|---------------------------------------------------------|
90+
| [Built-in Libraries](docs/native_api/buildin_librarys.md) | Available libraries and their usage |
91+
| [LLM Operations](docs/native_api/llm_operations.md) | LLM integration and API functions |
92+
| [Props Handling](docs/native_api/props_handling.md) | Property and configuration management |
9593

96-
Contributions are welcome! Feel free to submit a pull request or open an issue.
94+
### Other
95+
| **Document** | **Description** |
96+
|-----------------------------------------------------------------|---------------------------------------------------------|
97+
| [Licenses](docs/licenses.md) | List of licenses and copyrights |
9798

9899
## 📄 License
99100

100-
This project is licensed under the MIT License - see the [licenses.md](/docs/licenses.md) file for details.
101+
This project is licensed under the Unlicense - see the [LICENSE](LICENSE) file for details.
102+
103+
---

0 commit comments

Comments
 (0)