From 9329bba8c50758c7accabc71a5a5450418763606 Mon Sep 17 00:00:00 2001 From: Jaromil Date: Fri, 3 Jan 2025 16:15:43 +0100 Subject: [PATCH] docs: update the readme --- README.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9b8c727..d7eec3c 100644 --- a/README.md +++ b/README.md @@ -6,27 +6,31 @@ More info on [Dyne.org/CJIT](https://dyne.org/cjit). ## 🚀 Quick start -Download the CJIT executable for your system +Download [the latest CJIT release](https://github.com/dyne/cjit/releases/) for your system. -- Windows x86 64bit: [cjit.exe](https://github.com/dyne/cjit/releases/latest/download/cjit.exe) -- Apple/OSX: [cjit-Darwin-arm64](https://github.com/dyne/cjit/releases/download/v0.10.5/cjit-Darwin-arm64) -- GNU/Linux: [cjit-Linux-x86_64-static](https://github.com/dyne/cjit/releases/download/v0.10.5/cjit-Linux-x86_64-static) - -and run it with c source files as well dynamic libraries as arguments: +Launch CJIT from a terminal console command prompt: one can mix c source files and dynamic libraries as arguments: ``` ./cjit.exe mysource.c mylib.dll ``` -CJIT can do a lot more! continue reading its tutorial for a hands-on introduction. +If you like a tour, follow the [CJIT tutorial](https://dyne.org/docs/cjit). + +To quickly download a demo package (with games inside!) fire our installer script: + +### 🪟 On Windows -### 📖 [The CJIT tutorial](https://dyne.org/docs/cjit) + ``` + iex ((New-Object System.Net.WebClient).DownloadString('https://dyne.org/cjit/demo')) + ``` -## 💾 Downloads +### 🍎 / 🐧 On Apple/OSX and GNU/Linux -We provide ready to execute binary builds on [github releases](https://github.com/dyne/cjit/releases). + ``` + curl -sL https://dyne.org/cjit/demo.sh | bash + ``` -Some systems may warn you about a virus in the file. There isn't, we submit each built executable to Virustotal via [github actions](https://github.com/dyne/cjit/actions). +### 📖 Go to the [The CJIT tutorial](https://dyne.org/docs/cjit) ## ⚙️ Build from source @@ -67,7 +71,7 @@ The [CJIT's Frequently Asked Questions](https://dyne.org/docs/cjit/faq/) page ma ## 📑 License -CJIT is copyright (C) 2024 by the Dyne.org foundation +CJIT is copyright (C) 2024-2025 by the Dyne.org foundation CJIT is distributed under the GNU General Public License v3