Commit Graph

117 Commits

Author SHA1 Message Date
rltakashige
51a5191ff3 format readme (#978)
## Motivation

README looks weird after last update. 
<!-- Why is this change needed? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here -->

## Changes

<!-- Describe what you changed in detail -->

## Why It Works

<!-- Explain why your approach solves the problem -->

## Test Plan

### Manual Testing
<!-- Hardware: (e.g., MacBook Pro M1 Max 32GB, Mac Mini M2 16GB,
connected via Thunderbolt 4) -->
<!-- What you did: -->
<!-- - -->
I actually checked the file on GitHub this time.

### Automated Testing
<!-- Describe changes to automated tests, or how existing tests cover
this change -->
<!-- - -->
2025-12-22 18:06:27 +00:00
Evan Quiney
1efbd26388 add architecture.md, move images to docs/imgs (#968)
## Motivation

Documentation will make contribution easier and communicate our
development philosophy and decision process. Closes #967

## Changes

Added `architecture.md` to docs/ and moved the images out of docs and
into their own docs/imgs/ folder
2025-12-22 17:57:43 +00:00
rltakashige
fc41bfa1f1 Add all prerequisites to README (#975)
## Motivation

Addresses #974 
```
INFO: pip is looking at multiple versions of exo to determine which version is compatible with other requirements. This could take a while.
ERROR: Could not find a version that satisfies the requirement exo-pyo3-bindings (from exo) (from versions: none)
ERROR: No matching distribution found for exo-pyo3-bindings
```

## Changes

Describes Rust dependency for building from source

## Why It Works

<!-- Explain why your approach solves the problem -->

## Test Plan

### Manual Testing
<!-- Hardware: (e.g., MacBook Pro M1 Max 32GB, Mac Mini M2 16GB,
connected via Thunderbolt 4) -->
<!-- What you did: -->
<!-- - -->
Tested locally and runs after this setup without exo-pyo3-bindings error

### Automated Testing
<!-- Describe changes to automated tests, or how existing tests cover
this change -->
<!-- - -->
2025-12-22 17:38:51 +00:00
Nightguarder
1e75aeb2c2 Add Prerequisites to Readme (#936)
## Motivation
Users need to know what **prerequisites** they need in order to run exo.
Simple addition to docs prevents future raised issues.

## Changes

Updated ``README.md``:
- to include installation instructions for
**[uv](https://github.com/astral-sh/uv)** and
**[macmon](https://github.com/vladkens/macmon)**.

Updated ``CONTRIBUTING.md``:
-  to verify these prerequisites are met before starting development.

- Standardized on brew installation instructions for macOS users to keep
the guide simple.

## Why It Works

By listing these prerequisites upfront, users will set up their
environment correctly before attempting to run exo.

## Test Plan

### Manual Testing
MacBook Pro M4
- Verified that ``uv`` and ``macmon`` were missing initially, causing
failures
- after installing them via brew (as documented), uv run exo starts
successfully.

### Automated Testing
<!-- Describe changes to automated tests, or how existing tests cover
this change -->
<!-- - -->

---------

Co-authored-by: Evan Quiney <evanev7@gmail.com>
2025-12-22 02:28:08 +00:00
Alex Cheema
abaeb0323d Update README.md. (#956)
## Motivation

<!-- Why is this change needed? What problem does it solve? -->
Made a mistake on the merge of the last PR.
<!-- If it fixes an open issue, please link to the issue here -->

## Changes

<!-- Describe what you changed in detail -->

## Why It Works

<!-- Explain why your approach solves the problem -->

## Test Plan

### Manual Testing
<!-- Hardware: (e.g., MacBook Pro M1 Max 32GB, Mac Mini M2 16GB,
connected via Thunderbolt 4) -->
<!-- What you did: -->
<!-- - -->

### Automated Testing
<!-- Describe changes to automated tests, or how existing tests cover
this change -->
<!-- - -->
2025-12-21 23:09:44 +00:00
Alex Cheema
7d15fbdaab readme tweaks5 (#954)
## Motivation

<!-- Why is this change needed? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here -->

## Changes

<!-- Describe what you changed in detail -->

## Why It Works

<!-- Explain why your approach solves the problem -->

## Test Plan

### Manual Testing
<!-- Hardware: (e.g., MacBook Pro M1 Max 32GB, Mac Mini M2 16GB,
connected via Thunderbolt 4) -->
<!-- What you did: -->
<!-- - -->

### Automated Testing
<!-- Describe changes to automated tests, or how existing tests cover
this change -->
<!-- - -->
2025-12-21 22:48:35 +00:00
Alex Cheema
4a6e0fe171 Update README.md. (#949)
## Motivation

<!-- Why is this change needed? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here -->

## Changes

<!-- Describe what you changed in detail -->

## Why It Works

<!-- Explain why your approach solves the problem -->

## Test Plan

### Manual Testing
<!-- Hardware: (e.g., MacBook Pro M1 Max 32GB, Mac Mini M2 16GB,
connected via Thunderbolt 4) -->
<!-- What you did: -->
<!-- - -->

### Automated Testing
<!-- Describe changes to automated tests, or how existing tests cover
this change -->
<!-- - -->
2025-12-21 18:31:23 +00:00
Alex Cheema
f8483cfc18 Update README.md. (#932)
## Motivation

<!-- Why is this change needed? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here -->

## Changes

<!-- Describe what you changed in detail -->

## Why It Works

<!-- Explain why your approach solves the problem -->

## Test Plan

### Manual Testing
<!-- Hardware: (e.g., MacBook Pro M1 Max 32GB, Mac Mini M2 16GB,
connected via Thunderbolt 4) -->
<!-- What you did: -->
<!-- - -->

### Automated Testing
<!-- Describe changes to automated tests, or how existing tests cover
this change -->
<!-- - -->
2025-12-19 21:23:25 +00:00
Alex Cheema
8bafd6fe68 Update README.md (#925)
## Motivation

<!-- Why is this change needed? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here -->

## Changes

<!-- Describe what you changed in detail -->

## Why It Works

<!-- Explain why your approach solves the problem -->

## Test Plan

### Manual Testing
<!-- Hardware: (e.g., MacBook Pro M1 Max 32GB, Mac Mini M2 16GB,
connected via Thunderbolt 4) -->
<!-- What you did: -->
<!-- - -->

### Automated Testing
<!-- Describe changes to automated tests, or how existing tests cover
this change -->
<!-- - -->
2025-12-19 14:38:40 +00:00
Alex Cheema
4da0043253 Update README.md (#917) 2025-12-18 20:38:00 +00:00
Jake Hillion
74bae3ba6d Update README.md 2025-12-18 19:18:59 +00:00
Evan Quiney
9815283a82 8000 -> 52415 (#915)
* 8000 -> 52415

* dont grab the api port for placement

---------

Co-authored-by: rltakashige <rl.takashige@gmail.com>
2025-12-18 18:39:44 +00:00
Evan
274e35f926 update readme 2025-12-18 17:05:35 +00:00
Jake Hillion
19ca48c4f1 more readme fixups 2025-12-18 14:47:04 +00:00
Evan
28a6151b8e remove discord link from README 2025-12-18 14:02:38 +00:00
Jake Hillion
2c16e00be9 github docs 2025-12-18 13:49:07 +00:00
Jake Hillion
0fcee70833 prep repo for v1 2025-12-17 15:31:02 +00:00
Alex Cheema
5f18faec17 Update. 2025-10-30 11:59:59 -07:00
Alex Cheema
56f783b38d Update. 2025-10-21 17:29:48 +01:00
mags0ft
013d2573e7 remove dead links in README 2025-03-02 18:37:59 +01:00
Alex Cheema
f9a1e5342b update notice in README 2025-02-18 11:41:09 +00:00
Alex Cheema
cb4bee2694 add notice to README 2025-02-17 22:54:56 +00:00
Alex Cheema
d8c3aed0cc update discovery / peer networking modules 2025-02-08 02:15:13 +00:00
Alex Cheema
2c982d9295 update README to better reflect support for other devices like NVIDIA and Pi's 2025-02-08 02:13:04 +00:00
Alex Cheema
51b5c2ca9b add model downloading section to README 2025-02-01 20:23:05 +00:00
Alex Cheema
19a27c5bfd HF_HOME -> EXO_HOME 2025-01-27 02:59:23 +00:00
Alex Cheema
ad0e0d02d8 fix readme images 2025-01-23 02:17:58 +00:00
Alex Cheema
178cc4d961 add trending badge to README.md 2024-12-31 17:50:29 +00:00
Piyush Acharya
154e0f58e4 Implement suggestiond 2024-12-21 19:40:53 -08:00
Piyush Acharya
6c82365ee2 Improved clarity, fixed typos, added macOS/Linux examples, and enhanced installation/debugging instructions 2024-12-17 18:02:34 -08:00
Nel Nibcord
763fbf8486 Updated node refs 2024-12-11 02:54:01 -08:00
Alex Cheema
be82ac7d99 update readme to reflect that mlx and tinygrad are interoperable 2024-11-26 18:06:15 +04:00
Alex Cheema
2c5d05538c make readme clearer with linux nvidia 2024-11-24 00:18:46 +04:00
Alex Cheema
f2d5beee08 change chatgpt api port from 8000 to 52415 2024-11-16 10:58:55 +04:00
Alex Cheema
167e756b31 add documentation of HF_HOME model storage location in README. fixes #427 2024-11-11 20:08:33 +04:00
Alex Cheema
f82410f808 clear instructions on formatting with yapf, remove linting 2024-10-29 10:42:37 -07:00
Alex Cheema
08ca7adcd3 remove redundant screenshot image in README 2024-10-14 14:53:41 -07:00
Alex Cheema
29a9156ea5 try screenshot without html 2024-10-14 14:53:22 -07:00
Alex Cheema
d43176de9c resize screenshot to 80% 2024-10-14 14:52:13 -07:00
Alex Cheema
b387150305 Move screenshot up in the README to device equality section 2024-10-14 14:51:53 -07:00
Alessandro de Oliveira Faria (A.K.A.CABELO)
d554313db8 Update README.md 2024-10-14 18:08:39 -03:00
Alex Cheema
4443d3ce9a update README with docs on exo run command 2024-10-02 16:39:19 +04:00
Alex Cheema
90a88f31aa update readme with editable pip install 2024-10-02 16:35:55 +04:00
Alex Cheema
fa42f789ee Merge pull request #210 from GaetanLepage/fix-main-install
Improve setup.py for proper installation
2024-10-02 15:25:44 +04:00
Alex Cheema
1ccfdc3ca9 give examples of device configurations in readme 2024-10-02 15:07:43 +04:00
Alex Cheema
71e93a1045 simplify hardware requirements in readme 2024-10-02 15:02:52 +04:00
DevEmilio96
a7a9124dc9 Hardware Requirements 2024-10-01 11:51:13 +02:00
DevEmilio96
09e7216241 Hardware Requirements 2024-10-01 11:48:16 +02:00
DevEmilio96
c498930fa1 Hardware Requirement notes 2024-10-01 11:41:03 +02:00
DevEmilio96
8d0e8a8a36 Hardware Requirementes 2024-10-01 11:36:01 +02:00