Skip to content
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.

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

Update docs (CONTRIBUTING.md) #1053

Merged
merged 21 commits into from
Dec 14, 2024
Merged
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ We believe in the power of the OODA Loop - a decision-making framework that emph

3. Fork the repo and create your branch from `main`.
1. The name of the branch should start with the issue number and be descriptive of the changes you are making.
1. eg. 40--add-test-for-bug-123
2. Example: 9999--add-test-for-bug-123
4. If you've added code that should be tested, add tests.
5. Ensure the test suite passes.
6. Make sure your code lints.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

## 🌍 README Translations

[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md)
[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/ai16z/Elisa/blob/main/README_HE.md)

## ✨ Features

Expand Down
189 changes: 189 additions & 0 deletions README_HE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
<div align="rtl" dir="rtl">

# אלייזה 🤖

<div align="center">
<img src="./docs/static/img/eliza_banner.jpg" alt="אלייזה באנר" width="100%" />
</div>

<div align="center">

📖 [תיעוד](https://ai16z.github.io/eliza/) | 🎯 [דוגמאות](https://github.com/thejoven/awesome-eliza)
</div>


<div align="center">

[中文说明](https://github.com/ai16z/Elisa/blob/main/README_CN.md) | [日本語の説明](https://github.com/ai16z/Elisa/blob/main/README_JA.md) | [한국어 설명](https://github.com/ai16z/Elisa/blob/main/README_KOR.md) | [Français](https://github.com/ai16z/Elisa/blob/main/README_FR.md) | [Português](https://github.com/ai16z/Elisa/blob/main/README_PTBR.md) | [Türkçe](TR.md) | [Русский](https://github.com/ai16z/Elisa/blob/main/README_RU.md) | [Español](https://github.com/ai16z/Elisa/blob/main/README_ES.md) | [Italiano](https://github.com/ai16z/Elisa/blob/main/README_IT.md) | [ไทย](https://github.com/ai16z/Elisa/blob/main/README_TH.md) | [Deutsch](https://github.com/ai16z/Elisa/blob/main/README_DE.md) | [עִברִית](https://github.com/ai16z/Elisa/blob/main/README_HE.md)

</div>

<div dir="rtl" align="right">

## ✨ תכונות

- 🛠️ מחברים מלאים לדיסקורד, טוויטר וטלגרם
- 🔗 תמיכה בכל מודל (Llama, Grok, OpenAI, Anthropic, וכו')
- 👥 תמיכה בריבוי סוכנים וחדרים
- 📚 קל לשלב ולהשתמש במסמכים שלך
- 💾 זיכרון ומאגר מסמכים הניתנים לשליפה
- 🚀 ניתן להרחבה רבה - יצירת פעולות ולקוחות משלך
- ☁️ תומך בהרבה מודלים (local Llama, OpenAI, Anthropic, Groq ,
וכו')
- 📦 פשוט עובד!

</div>

## 🎯 מקרי שימוש

<div align="right">
- 🤖 צ'טבוטים
</div>
<div align="right">
- 🕵️ סוכנים אוטונומיים
</div>
<div align="right">
- 📈 טיפול בתהליכים עסקיים
</div>
<div align="right">
- 🎮 במשחקי וידאו (NPCs)
</div>
<div align="right">
- 🧠 מסחר
</div>

## 🚀 התחלה מהירה

<div align="right">

### דרישות מוקדמות

[Python 2.7+](https://www.python.org/downloads/) -

[Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) -

[pnpm](https://pnpm.io/installation) -

> **הערה למשתמשי Windows:** נדרש [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual)

</div>

### שימוש ב-Starter (מומלץ)

<div align="right" dir="ltr">

```
git clone https://github.com/ai16z/eliza-starter.git

cp .env.example .env

pnpm i && pnpm start
```

</div>


לאחר מכן קרא את [התיעוד](https://ai16z.github.io/eliza/) כדי ללמוד כיצד להתאים את אלייזה.

### התחלה ידנית של אלייזה (מומלץ רק למי שיודע מה הוא עושה)
<div align="right">

```
# שכפול המאגר
git clone https://github.com/ai16z/eliza.git

# מעבר לגרסה האחרונה
git checkout $(git describe --tags --abbrev=0)
```
</div>

### התחלת אלייזה עם Gitpod

<div align="right">

[![פתח ב-Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)

</div>

### עריכת קובץ .env

<div align="right">

העתק את .env.example ל-.env ומלא את הערכים המתאימים.

```
cp .env.example .env
```

</div>

הערה: .env הוא אופציונלי. אם אתם מתכננים להפעיל מספר סוכנים נפרדים, ניתן להעביר סודות דרך JSON הדמות.

### התחלה אוטומטית של אלייזה

פעולה זו תפעיל הכל כדי להגדיר את הפרויקט ולהתחיל את הבוט עם הדמות המובנית.

<div align="right">

```bash
sh scripts/start.sh
```

</div>

### עריכת קובץ הדמות

1. פתח את `agent/src/character.ts` כדי לשנות את דמות ברירת המחדל. בטל הערה וערוך.

2. לטעינת דמויות מותאמות אישית:
- השתמש ב-`pnpm start --characters="path/to/your/character.json"`
- ניתן לטעון מספר קבצי דמויות בו זמנית.

3. התחבר עם X (טוויטר):
- שנה `"clients": []` ל-`"clients": ["twitter"]` בקובץ הדמות כדי להתחבר ל-X.

### התחלה ידנית של אלייזה
<div align="right">

```bash
pnpm i
pnpm build
pnpm start

# לעיתים צריך לנקות את הפרויקט אם חוזרים אליו לאחר זמן
pnpm clean
```
</div>

#### דרישות נוספות

ייתכן שתצטרך להתקין את Sharp. אם אתה רואה שגיאה בעת ההפעלה, נסה להתקין עם הפקודה הבאה:

```
pnpm install --include=optional sharp
```

### קהילה ויצירת קשר

<div align="right">

[GitHub Issues](https://github.com/ai16z/eliza/issues) מתאים ביותר עבור: באגים ופרופוזיציות לתכונות -

[Discord](https://discord.gg/ai16z) מתאים ביותר עבור: שיתוף היישומים שלך והשתתפות בקהילה -
</div>

## תורמים

<!-- <div align="right"> -->

<a href="https://github.com/ai16z/eliza/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ai16z/eliza" />
</a>

<!-- </div> -->

## היסטוריית כוכבים

[![תרשים היסטוריית כוכבים](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)

</div>
Loading