G6

Author: 1T17

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing to GGcode
+
+Thank you for your interest in contributing to GGcode! Your help makes this project better for everyone.
+
+## 📝 How to Contribute
+
+- **Bug Reports & Feature Requests:**
+  - Please use [GitHub Issues](https://github.com/1T17/GGcode/issues) to report bugs or suggest features.
+  - Include as much detail as possible (steps to reproduce, expected/actual behavior, screenshots, etc).
+
+- **Pull Requests:**
+  1. Fork the repository and create your branch from `main`.
+  2. Write clear, concise commit messages.
+  3. Add tests for new features or bug fixes if possible.
+  4. Ensure all tests pass (`make test` or `npm test` if applicable).
+  5. Open a pull request and describe your changes.
+
+## 🧑‍💻 Code Style
+
+- **C code:**
+  - Use 4 spaces for indentation.
+  - Follow existing naming conventions.
+  - Add comments for complex logic.
+- **JavaScript/Node.js:**
+  - Use 2 spaces for indentation.
+  - Prefer `const`/`let` over `var`.
+  - Use semicolons and single quotes.
+- **General:**
+  - Keep functions small and focused.
+  - Write descriptive variable and function names.
+  - Document public functions with comments.
+
+## 🧪 Testing
+
+- Run all tests before submitting a pull request.
+- Add new tests for new features or bug fixes.
+- Test both the C and Node.js sides if your change affects both.
+
+## ✍️ Contributing GGcode Scripts & Algorithms
+
+We welcome contributions of new GGcode scripts, toolpath algorithms, and parametric machining logic! Here’s how to make your script contributions clear, reusable, and high-quality:
+
+### Script Style & Best Practices
+- **Use clear variable names** (e.g., `radius`, `feed_rate`, `passes`).
+- **Add comments** to explain the purpose of each section and any tricky logic.
+- **Group related logic** into functions when possible.
+- **Use `note {}` blocks** for runtime comments and debug output.
+- **Prefer parametric/variable-driven code** over hardcoded values.
+- **Document required input variables** at the top of your script.
+- **Include a sample output or screenshot** if possible (in your pull request).
+
+### Example GGcode Script Contribution
+```ggcode
+// Spiral pocketing example
+let center_x = 0
+let center_y = 0
+let start_radius = 5
+let end_radius = 20
+let step = 1
+let feed = 300
+
+note {Spiral pocketing from R[start_radius] to R[end_radius]}
+
+for r = start_radius..end_radius step step {
+    G1 X[center_x + r] Y[center_y] F[feed]
+}
+```
+
+### Algorithm Contributions
+- **Describe the algorithm** in your pull request (what problem it solves, how it works).
+- **Add comments** in the code for each major step.
+- **If porting from another language or paper, cite the source.**
+- **Add tests or example GGcode files** in the `GGCODE/` directory.
+- **If your algorithm is complex, consider adding a markdown file explaining it in `/docs` or as a comment block.**
+
+### Where to Put Your Scripts
+- Place example or reusable scripts in the `GGCODE/` directory.
+- Add a short comment at the top with your name/handle and a description.
+
+---
+
+## 📦 Project Structure
+
+See the [README.md](./README.md#project-structure) for an overview of the project layout.
+
+## 📧 Contact
+
+For questions, reach out to [[email protected]](mailto:[email protected]).
+
+---
+
+Thank you for helping make GGcode better! 

README.md

@@ -9,6 +9,8 @@
 
 ---
 
+
+
 ## ✨ Features
 
 **🪶 Lightweight & Embeddable**  
@@ -121,6 +123,38 @@ To compile and run a `.ggcode` file:
 
 If no file is specified, GGcode will automatically compile **all `.ggcode` files** in the current directory.
 
+---
+## 🚦 Quick Start
+
+```sh
+# Build the compiler and Node.js backend
+make all
+make node
+
+# Start the web UI (from the node directory)
+cd node
+node ggcode.js
+
+# Open in your browser:
+http://localhost:3000
+```
+
+---
+
+## 📁 Project Structure
+
+```
+GGcode/
+├── src/           # C source code for the compiler and runtime
+├── node/          # Node.js backend and web frontend
+├── tests/         # Unit and integration tests
+├── bin/           # Compiled binaries and test runners
+├── GGCODE/        # Example and test .ggcode files
+├── README.md      # This file
+├── Makefile       # Build automation
+└── ...
+```
+
 ---
 
 ## 🧾 Supported Syntax

node/package.json

@@ -4,6 +4,7 @@
   "description": "",
   "main": "test.js",
   "scripts": {
+    "start": "node ggcode.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],

node/views/index.ejs

@@ -273,13 +273,9 @@
       <div class="control-left">
 
 
-
-        <div class="separator"></div>
         <div class="button-group">
           <span class="group-label">GG-code</span>
 
-
-
           <button type="submit" class="primary" title="Compile GGcode">
             <svg width="14" height="14" viewBox="0 0 12 12" fill="currentColor">
               <path d="M2.5 1.5L8.5 6L2.5 10.5V1.5Z"/>

src/bindings/nodejs.c

@@ -17,11 +17,9 @@ extern int statement_count;
 
 // In your function later:
 
-
 const char* compile_ggcode_from_string(const char* source_code) {
 
     int debug = get_debug();
-
     // Initialize runtime state
     init_runtime();
     Runtime* runtime = get_runtime();
@@ -35,56 +33,30 @@ if (!source_code || source_code[0] == '\0') {
 
     // reset_runtime_state();
     init_output_buffer();
-
-
-    
     ASTNode* root = parse_script_from_string(source_code);
-
-
     emit_gcode(root, -1);  // Use runtime state for debug
 
     // === Insert G-code header with % and ID ===
 
     char ggcode_file_name[64];
     snprintf(ggcode_file_name, sizeof(ggcode_file_name), "nodejs.ggcode");
-
     emit_gcode_preamble(debug, ggcode_file_name);
 
-
-
-
-
 // const char* buffer = get_output_buffer();
-
-
 // printf("DEBUG RAW OUTPUT: '%s'\n", buffer);  // See what's really there
 
-
-
     const char* output = strdup(get_output_buffer());
 
-
-
     if (!root || has_errors()) {
         report_error("[NodeJS] Compilation failed or errors detected");
         print_errors();
         clear_errors();
         return strdup("; ERROR\n");
     }
 
-
-
    reset_runtime_state(); 
-
-
     free_ast(root);
-
-
-
-
     free_output_buffer();
-
-
     return output;
 }
 

src/main.c

@@ -5,6 +5,7 @@
 #include <unistd.h>
 #include <string.h>
 #include <libgen.h>  
+#include <errno.h>
 
 #ifdef _WIN32
 #include <tchar.h>
@@ -34,35 +35,16 @@
 #include "utils/file_utils.h"
 #include "utils/report.h"
 #include "error/error.h"
-#define FATAL_ERROR(msg, ...) fatal_error(NULL, 0, 0, msg, ##__VA_ARGS__)
-
 #include "utils/time_utils.h"
-#include <errno.h>
-
-
-
-
-
 
 
-
-
-
- // int statement_count = 0;
-
+#define FATAL_ERROR(msg, ...) fatal_error(NULL, 0, 0, msg, ##__VA_ARGS__)
 
 // Declare the runtime variable lookup functions from evaluator.c
-
-
-
 const char* GGCODE_INPUT_FILENAME = NULL;
-
-
 void compile_file(const char* input_path, const char* output_path, int debug);
 
 
-
-
 void make_g_gcode_filename(const char *src, char *dst, size_t dst_size) {
     size_t len = strlen(src);
     if (len > 7 && strcmp(src + len - 7, ".ggcode") == 0) {
@@ -72,19 +54,13 @@ void make_g_gcode_filename(const char *src, char *dst, size_t dst_size) {
     }
 }
 
-
-
 // Helper to check if a string ends with .ggcode
 int ends_with_ggcode(const char *filename) {
     size_t len = strlen(filename);
     return len > 7 && strcmp(filename + len - 7, ".ggcode") == 0;
 }
 
 
-
-
-
-
 void compile_file(const char* input_path, const char* output_path, int debug) {
     // Initialize runtime state
     init_runtime();
@@ -133,25 +109,20 @@ void compile_file(const char* input_path, const char* output_path, int debug) {
     Timer parse_timer;
     start_timer(&parse_timer);
 
-
-ASTNode* root = parse_script_from_string(source);
-
-
+    ASTNode* root = parse_script_from_string(source); 
     double parse_time = end_timer(&parse_timer);
 
     // Emit timing
     Timer emit_timer;
     start_timer(&emit_timer);
 
-    reset_line_number();
-
+ //   reset_line_number();
     emit_gcode(root, -1);  // Use runtime state for debug
     double emit_time = end_timer(&emit_timer);
 
     // ➤ Insert G-code header at the beginning AFTER emit
     emit_gcode_preamble(debug, filename);
 
-
 // Measure memory usage (Linux/macOS/Windows)
 long memory_kb = 0;
 
@@ -167,7 +138,6 @@ long memory_kb = 0;
     }
 #endif
 
-
     // Output
     if (get_output_to_file()) {
         FILE* out = fopen(output_path, "w");

src/runtime/evaluator.h

@@ -14,24 +14,16 @@
 #define M_E 2.71828182845904523536
 #endif
 
-
-
-
 void enter_scope(void);
 void exit_scope(void);
 
-
-
-
-
 // --- Value types ---
 typedef enum {
     VAL_NUMBER,
     VAL_ARRAY
 } ValueType;
 
-
-
+// --- Value ---
 typedef struct Value {
     ValueType type;
     union {

src/runtime/runtime_state.h

@@ -10,17 +10,20 @@
 // Forward declarations
 struct Value;
 
+// --- Variable ---
 typedef struct {
     char *name;
     int scope_level;
     struct Value *val;
 } Variable;
 
+// --- Function ---
 typedef struct {
     char *name;
     ASTNode *node; // AST_FUNCTION node
 } FunctionEntry;
 
+// --- Runtime State ---
 typedef struct Runtime {
     int statement_count;
     char RUNTIME_TIME[64];