From d0b76b588fd6966d839763437a5ef55c65676c37 Mon Sep 17 00:00:00 2001 From: Nicolas Date: Wed, 15 Oct 2025 22:56:59 +0200 Subject: [PATCH] readme updated --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 016a826..de02c42 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,22 @@ Development is in a very early stage. Only very few components are in a working # Introduction -Copapy is a copy and patch based compiler. It compiles a python based language to machine code. The language can be considered as an embedded language. It uses the python interpreter for generating a directed graph of variables and operations. The compiler generates machine code by composing pre-compiled stencils derived from C code with gcc -O3. +Copapy is a python based embedded domain specific language (eDSL) with a copy & patch compiler. It compiles to machine code. It uses the python interpreter for compilation. It generates a directed graph of variables and operations. The compiler generates machine code by composing pre-compiled stencils derived from C code with gcc -O3. -For code execution a runner executable receives the composed machine code, data and patch instructions. The patch instructions are used to correct memory address offsets. +For code execution a executable or library receives the composed machine code, data and patch instructions. The patch instructions are used to correct memory address offsets. -The Project targets applications that profit from fast implementation (e.g. prototyping) and require realtime with low latency as well as minimizing risk of implementation errors reaching runtime. This applies primarily for applications interfacing hardware, where runtime errors might lead to physical damage. +The Project targets applications that profit from fast implementation (e.g. prototyping) and require realtime with low latency as well as minimizing risk of implementation errors not cached during compile time. This applies primarily for applications interfacing hardware, where runtime errors might lead to physical damage. For example robotics, embedded systems and control systems. -The project aims to be: -- Type save -- Having turing completeness only during compile time -- Predictable runtime -- No software runtime errors +The language aims to be: +- Fast to write +- Easy to read +- Type safe +- Having a predictable runtime +- Turing-complete only during compile time +- No runtime errors - Immutable types -# Structure +# How it works ## Compilation The Compilation step starts with the directed graph of variables and operations generated by the python interpreter.