Skip to content

Commit

Permalink
docs: update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jaromil committed Jan 3, 2025
1 parent 60cfae4 commit 9329bba
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 9329bba

Please sign in to comment.