Skip to content

Fix: correct local build instructions in README #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
outbacknash wants to merge 2 commits into from
Closed

Fix: correct local build instructions in README #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94fb1c5
Update README.md
talsraviv Mar 15, 2026
000d586
Fix: correct local build instructions in README
outbacknash Mar 16, 2026
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
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@
<img src="./src/icon.png" width="96" alt="Familiar icon" />
</p>

<h1 align="center">Familiar: Invite AI to sit next to you.</h1>
<h1 align="center">Familiar: Let AI update itself.</h1>

<p align="center">
<a href="https://github.com/familiar-software/familiar/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GPL--3.0-blue" alt="GPL-3.0 License" /></a>
</p>

Familiar turns everything on your screen and clipboard into context for your existing AI.

Free, open source, and offline. Nothing leaves your machine.
Familiar watches you work so your AI can create its own skills and update its knowledge. Free, open source, local, and offline.

## Website

Expand All @@ -28,7 +26,7 @@ Free, open source, and offline. Nothing leaves your machine.

```bash
git clone https://github.com/familiar-software/familiar.git
cd familiar/code/desktopapp
cd familiar
npm install
npm start
```
Expand Down
Loading