From 6a32c4721c69429bc5599d968523b125f21add49 Mon Sep 17 00:00:00 2001 From: William Bell <62452284+Ugric@users.noreply.github.com> Date: Sun, 30 Nov 2025 05:33:20 +0000 Subject: [PATCH] update readme to have build instructions --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 72a24e7..104f16e 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,24 @@ SPDX-License-Identifier: GPL-3.0-or-later Chloride is the new C-based interpreter for the Argon programming language. It is designed as a drop-in replacement for the older Go implementation (argon-v3), while introducing a more efficient runtime and a cleaner, more consistent object model. +## Build + +Currently, builds are only being made for linux x86_64 at [the projects Jenklins instance](https://jenkins.wbell.dev/job/chloride/). + +If this does not satify your requirements, feel free to build for your platform. the dependancies are `conan`, `flex`, `cmake` and `gcc`. + +install using conan. +``` +conan install . --build=missing +``` + +and finally build using conan. +``` +conan build . +``` + +the final build can be found in `build/bin`. + ## Overview Chloride aims to remain as interchangeable with argon-v3 as possible.