github-mirror/project-nomad
1
0
Fork 0
mirror of https://github.com/Crosstalk-Solutions/project-nomad.git synced 2026-10-17 05:14:19 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

docs: trim the quickstart note to one line plus a link

Browse Source 
Three copies of a figure that varies is worse than one. Keep the two
numbers a reader needs before running the install command, and move the
detail down to Device Requirements where it sits with the specs.

Suggested by @mk-pmb on #1271.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01F8Mgg1vd2eKSs8StZiuyMV
This commit is contained in:
Chris Sherwood 2026-09-01 08:51:19 -07:00 committed by Jake Turner
parent 4aa70c7038
commit c1d527dbbd
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -17,7 +17,7 @@ Project NOMAD is a self-contained, offline-first knowledge and education server
## Installation & Quickstart
Project NOMAD can be installed on any Debian-based operating system (we recommend Ubuntu 26.04 LTS; 24.04 LTS and Debian 12 are also supported). Installation is completely terminal-based, and all tools and resources are designed to be accessed through the browser, so there's no need for a desktop environment if you'd rather setup NOMAD as a "server" and access it through other clients.
**Disk space:** NOMAD itself needs about **5 GB**, so plan for **10 GB free** to install comfortably. Adding the AI Assistant needs roughly **25 GB** in total, since Ollama and a general-purpose model are large. Offline content is downloaded separately and is what actually fills a drive: a full Wikipedia or a regional map set runs to tens or hundreds of gigabytes, so an SSD of 500 GB or more is the practical recommendation once you start adding libraries. See the [FAQ](https://www.projectnomad.us/docs/faq) for content sizes.
**Before you start:** NOMAD itself needs about **5 GB of disk and under 1 GB of RAM**. The offline content you add afterwards is what actually fills a drive, and the AI Assistant is what drives the memory requirement up. See [Device Requirements](#device-requirements) for both, and the [FAQ](https://www.projectnomad.us/docs/faq) for individual content sizes.
*Note: sudo/root privileges are required to run the install script*
@ -78,10 +78,12 @@ At its core, however, NOMAD is still very lightweight. For a barebones installat
#### Minimum Specs
- Processor: 2 GHz dual-core processor or better
- RAM: 4GB system memory (the whole stack without AI runs in under 1 GB)
- Storage: At least 5 GB free disk space
- Storage: At least 5 GB free disk space (plan for 10 GB to install comfortably)
- OS: Debian-based (Ubuntu 26.04 LTS recommended)
- Stable internet connection (required during install only)
Adding the AI Assistant brings the install to roughly **25 GB**, because Ollama and a general-purpose model are both large, and a model needs about its download size in memory while it answers. That memory comes from VRAM if you have a discrete GPU and from system RAM if you do not, which is the single biggest reason the figures below are so much higher.
To run LLMs and other included AI tools:
#### Optimal Specs