|
7 | 7 |
|
8 | 8 | ## A SQL-like language for efficient code analysis and transformations
|
9 | 9 |
|
10 |
| -### CEDARScript ELI5'ed |
| 10 | +## Table of Contents |
| 11 | +- [What is CEDARScript?](#what-is-cedarscript) |
| 12 | +- [CEDARScript ELI5'ed](#cedarscript-eli5-ed) |
| 13 | +- [Technical Overview](#technical-overview) |
| 14 | +- [Key Features](#key-features) |
| 15 | +- [Supported Languages](#supported-languages) |
| 16 | +- [How can CEDARScript be used](#how-can-cedarscript-be-used) |
| 17 | +- [Examples](#examples) |
| 18 | +- [Planned Features](#planned-features) |
| 19 | +- [Future Enhancements](#future-enhancements) |
| 20 | +- [Related](#related) |
| 21 | + |
| 22 | +## CEDARScript ELI5'ed |
11 | 23 | Imagine a vast _library_ (`your codebase`) with millions of _books_ (`files`) across thousands of _shelves_ (`directories`).
|
12 | 24 | Traditional code editing is like manually searching through each book, line by line, character by character, to find
|
13 | 25 | relevant information or make changes.
|
@@ -44,7 +56,7 @@ There are a few podcasts discussing CEDARScript you can listen to:
|
44 | 56 | 2. [CEDARScript's _TurboKognition_ and _GanzPunktGenau_ editing](https://open.spotify.com/episode/79xCOfrvMZJPenLdKJiNZj?si=Mo2ofU_lRYKwxRZoCPJn6Q)
|
45 | 57 | 3. [Discussion of an LLM chat held during a benchmark and some command examples](https://podcasters.spotify.com/pod/show/elifarley/episodes/CEDARScript-chat-during-a-benchmark-test--command-examples-e2ptlq4)
|
46 | 58 |
|
47 |
| -### Technical Overview |
| 59 | +## Technical Overview |
48 | 60 | `CEDARScript` (_Concise Examination, Development, And Refactoring Script_) is a **SQL**-like language designed to
|
49 | 61 | lower costs and improve the efficiency and accuracy of AI code assistants. It enables offloading low-level code syntax and
|
50 | 62 | structure concerns, such as indentation and line counting, from the LLMs.
|
@@ -118,13 +130,13 @@ but only **Python** has been tested so far.
|
118 | 130 |
|
119 | 131 | ## Projects using the CEDARScript Language
|
120 | 132 |
|
121 |
| -1. [CEDARScript AST Parser (Python)](https://github.com/CEDARScript/cedarscript-ast-parser-python) |
122 |
| -2. [CEDARScript Editor](https://github.com/CEDARScript/cedarscript-editor-python) |
123 |
| -3. [CEDARScript Prompt Engineering](https://github.com/CEDARScript/cedarscript-llm-prompt-engineering) |
| 133 | +1. [CEDARScript Integration: Aider](https://github.com/CEDARScript/cedarscript-integration-aider) - Provides |
| 134 | +`CEDARScript` [_edit format_](https://aider.chat/docs/llms/editing-format.html) for [Aider](https://aider.chat/) |
| 135 | +2. [CEDARScript AST Parser (Python)](https://github.com/CEDARScript/cedarscript-ast-parser-python) |
| 136 | +3. [CEDARScript Editor](https://github.com/CEDARScript/cedarscript-editor-python) |
| 137 | +4. [CEDARScript Prompt Engineering](https://github.com/CEDARScript/cedarscript-llm-prompt-engineering) |
124 | 138 | - Provides prompts that teach `CEDARScript` to LLMs
|
125 | 139 | - Also includes real conversations held via Aider in which an LLM uses this language to propose code modifications
|
126 |
| -4. [CEDARScript Integration: Aider](https://github.com/CEDARScript/cedarscript-integration-aider) - Provides |
127 |
| -`CEDARScript` [_edit format_](https://aider.chat/docs/llms/editing-format.html) for [Aider](https://aider.chat/) |
128 | 140 |
|
129 | 141 | ## How can CEDARScript be used?
|
130 | 142 |
|
|
0 commit comments