Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![alt text](./assets/inference-logo-oulined-shaped-font.svg)

[![Build](https://github.com/Inferara/inference/actions/workflows/build_main.yml/badge.svg?branch=main)](https://github.com/Inferara/inference/actions/workflows/build_main.yml)
[![codecov](https://codecov.io/gh/Inferara/inference/branch/main/graph/badge.svg)](https://codecov.io/gh/Inferara/inference)

Expand Down Expand Up @@ -69,10 +71,10 @@ infs --version

### Exit Codes

| Code | Meaning |
|------|---------------------------------|
| 0 | Success |
| 1 | Usage / IO / Parse failure |
| Code | Meaning |
| ---- | -------------------------- |
| 0 | Success |
| 1 | Usage / IO / Parse failure |

### Future Commands (Planned)

Expand All @@ -90,10 +92,10 @@ Prebuilt binaries are available for each release. Two CLI tools are distributed:

### Release Artifacts

| Platform | infs | infc |
|----------|------|------|
| Linux x64 | `infs-linux-x64.tar.gz` | `infc-linux-x64.tar.gz` |
| Windows x64 | `infs-windows-x64.zip` | `infc-windows-x64.zip` |
| Platform | infs | infc |
| ----------- | --------------------------------- | --------------------------------- |
| Linux x64 | `infs-linux-x64.tar.gz` | `infc-linux-x64.tar.gz` |
| Windows x64 | `infs-windows-x64.zip` | `infc-windows-x64.zip` |
| macOS ARM64 | `infs-macos-apple-silicon.tar.gz` | `infc-macos-apple-silicon.tar.gz` |

### Directory Structure
Expand All @@ -110,6 +112,7 @@ The CLI binaries are self-contained and require no external dependencies.
To build Inference from source:

For detailed platform-specific setup instructions, see:

- [Linux Development Setup](book/installation_linux.md)
- [macOS Development Setup](book/installation_macos.md)
- [Windows Development Setup](book/installation_windows.md)
Expand All @@ -121,12 +124,14 @@ No external binaries are required. The compiler generates WebAssembly directly v
### Build Steps

1. Clone the repository:

```bash
git clone https://github.com/Inferara/inference.git
cd inference
```

2. Build the project:

```bash
cargo build --release
```
Expand Down
45 changes: 45 additions & 0 deletions assets/inference-logo-oulined-shaped-font.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.