Skip to content

Commit

Permalink
docs: 📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
viarotel committed Dec 19, 2024
1 parent 10b902a commit b7629f3
Show file tree
Hide file tree
Showing 9 changed files with 62 additions and 29 deletions.
21 changes: 15 additions & 6 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- 🏃 同步:得益于 Web 技术,将更快速的与 Scrcpy 保持同步
- 🤖 自动化:自动连接设备、自动执行镜像、自定义脚本、计划任务
- 💡 定制化:多设备管理、独立配置、自定义备注、配置导入导出
- 📡 无线:通过扫描二维码快速连接
- 🔗 反向供网:Gnirehtet 反向供网
- 🎨 主题:浅色模式、深色模式、跟随系统切换
- 😎 轻巧度:本机支持,仅显示设备屏幕
Expand Down Expand Up @@ -53,10 +54,18 @@

### WIFI 连接

#### 扫描二维码连接
1. 同 USB 连接中的 1-2 步骤
2. 在开发者模式中打开并进入无线调试
3. 点击使用二维码配对设备
4. 开始享受吧

#### 通过IP地址连接

> 注意:如果首次无线连接失败,你可能需要无线配对请参阅 [常见问题](#常见问题)
>
> 注意:需同时开启无线调试功能,并在无线调试页面中获取你的当前设备的无线地址(通常为你连接 WIFI 时分配的 IP 地址)及端口号(默认为 5555)
1. 同 USB 连接中的 1-2 步骤
2. 将获取到的设备 IP 地址及端口号填写到 Escrcpy 中,然后点击连接设备
3. 这时 Escrcpy 设备列表应该已经检测到你的手机,点击开始镜像
Expand Down Expand Up @@ -109,7 +118,7 @@ Windows 及 Linux 端内部集成了 Gnirehtet, 用于提供 PC 到安卓设
- 切换键
- 主屏幕
- 返回键
- 启动APP
- 启动APP(多屏协同)
- 关闭屏幕(实验性)
- 通知栏
- 电源键
Expand All @@ -122,7 +131,6 @@ Windows 及 Linux 端内部集成了 Gnirehtet, 用于提供 PC 到安卓设
- 执行脚本
- 计划任务
- 反向供网(Gnirehtet)
- 多屏协同 (废弃)

## 偏好设置

Expand Down Expand Up @@ -151,6 +159,7 @@ Windows 及 Linux 端内部集成了 Gnirehtet, 用于提供 PC 到安卓设
- 刷新率
- 视频编码
- 显示方向
- 旋转角度
- 屏幕裁剪
- 显示器
- 视频缓冲
Expand Down Expand Up @@ -239,9 +248,9 @@ Windows 及 Linux 端内部集成了 Gnirehtet, 用于提供 PC 到安卓设
24. 增强录制功能 ✅
25. 启动APP(多线程) ✅
26. 主窗口贴边隐藏 ✅
27. 改进历史设备连接体验 🚧
28. 文件管理支持上传目录及进度展示🚧
29. 对设备进行分组 🚧
27. 对设备进行分组(通过筛选备注) ✅
28. 改进历史设备连接体验 ✅
29. 文件管理支持上传目录及进度展示🚧
30. 游戏键位映射 🚧

## 常见问题
Expand Down
32 changes: 22 additions & 10 deletions README-RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- 🏃 Синхронность: Использование веб-технологий для более быстрой синхронизации с Scrcpy
- 🤖 Автоматизация: Автоподключение устройств, автоисполнение изображений, пользовательские скрипты, запланированные задачи
- 💡 Настройка: Управление несколькими устройствами, независимые конфигурации, пользовательские заметки, импорт/экспорт настроек
- 📡 Беспроводная связь: Быстрое подключение путём сканирования QR-кода
- 🔗 Обратный тетеринг: Обратный тетеринг с помощью Gnirehtet
- 🎨 Темы: Светлая тема, темная тема, переключение в зависимости от системы
- 😎 Легковесность: Нативная поддержка, отображает только экран устройства
Expand Down Expand Up @@ -53,12 +54,23 @@

### Подключение по Wi-Fi

> Примечание: Для беспроводной отладки необходимо включить беспроводную отладку на странице беспроводной отладки телефона, чтобы получить IP-адрес (обычно IP, назначенный при подключении к Wi-Fi) и номер порта (по умолчанию 5555) устройства
#### Подключение с помощью QR-кода

1. Следуйте шагам 1-2 из раздела "Подключение по USB"
2. Введите IP-адрес устройства и номер порта, полученные на предыдущем шаге, в Escrcpy и нажмите "Подключить устройство"
3. В списке устройств Escrcpy должно обнаружить ваш телефон, нажмите "Начать зеркалирование"
4. Наслаждайтесь!
1. Выполните шаги 1-2 из USB-подключения
2. Включите и войдите в беспроводную отладку в режиме разработчика
3. Нажмите "Сопряжение устройства с помощью QR-кода"
4. Начните пользоваться!

#### Подключение через IP-адрес

> Примечание: Если первоначальное беспроводное подключение не удалось, возможно, потребуется беспроводное сопряжение. Обратитесь к разделу [FAQ](#FAQ)
>
> Примечание: Необходимо включить беспроводную отладку и получить беспроводной адрес устройства (обычно это IP-адрес, назначенный при подключении к WiFi) и номер порта (по умолчанию 5555) на странице беспроводной отладки
1. Выполните шаги 1-2 из USB-подключения
2. Введите полученный IP-адрес устройства и номер порта в Escrcpy, затем нажмите подключить устройство
3. К этому моменту список устройств Escrcpy должен обнаружить ваш телефон, нажмите начать трансляцию
4. Начните пользоваться!

### macOS и Linux

Expand Down Expand Up @@ -109,7 +121,7 @@ Gnirehtet встроен в приложения для Windows и Linux, что
- Переключатель
- Домой
- Назад
- Запустить приложение
- Запустить приложение (Группа зеркалирования)
- Выключение экрана (экспериментально)
- Уведомление
- Питание
Expand All @@ -122,7 +134,6 @@ Gnirehtet встроен в приложения для Windows и Linux, что
- Выполнить скрипт
- Запланированная задача
- Gnirehtet
- Группа зеркалирования (отказаться)

## Настройки

Expand Down Expand Up @@ -151,6 +162,7 @@ Gnirehtet встроен в приложения для Windows и Linux, что
- Частота обновления
- Кодек видео
- Ориентация дисплея
- Угол поворота
- Обрезка экрана
- Монитор
- Видео буфер
Expand Down Expand Up @@ -238,9 +250,9 @@ Gnirehtet встроен в приложения для Windows и Linux, что
23. Плавающая панель управления ✅
24. Улучшенная запись ✅
25. Запустить приложение (многопоточное) ✅
26. Улучшен опыт подключения истории устройств 🚧
27. Управление файлами поддерживает каталог загрузки и отображение прогресса 🚧
28. Группировка устройств 🚧
26. Группировать устройства (по фильтрации примечаний) ✅
27. Улучшен опыт подключения истории устройств ✅
28. Управление файлами поддерживает каталог загрузки и отображение прогресса 🚧
29. Карта клавиш для игр 🚧

## Часто задаваемые вопросы
Expand Down
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- 🏃 Synchronous: Benefit from web technologies to synchronize with Scrcpy faster
- 🤖 Automation: Auto-connect devices, auto-execute images, custom scripts, scheduled tasks
- 💡 Customization: Multi-device management, independent configurations, custom notes, config import/export
- 📡 Wireless: Quick connect by scanning QR code
- 🔗 Reverse tethering: Gnirehtet reverse tethering
- 🎨 Themes: Light mode, dark mode, system-based switching
- 😎 Lightweight: Native support, only display device screen
Expand Down Expand Up @@ -53,12 +54,23 @@ See [homebrew-escrcpy](https://github.com/viarotel-org/homebrew-escrcpy)

### WIFI Connection

> Note: Wireless debugging needs to be enabled on your phone's wireless debugging page to get the IP address (usually the IP assigned when connecting to WIFI) and port number (default 5555) of the device
#### Scan QR Code to Connect

1. Follow steps 1-2 in USB Connection
2. Input the device IP address and port number obtained to Escrcpy and click connect device
3. The device list in Escrcpy should have detected your phone, click start mirroring
4. Enjoy!
1. Follow steps 1-2 from USB connection
2. Enable and enter wireless debugging in developer mode
3. Click "Pair device using QR code"
4. Start enjoying!

#### Connect via IP Address

> Note: If initial wireless connection fails, you may need wireless pairing. Please refer to [FAQ](#FAQ)
>
> Note: You need to enable wireless debugging and obtain your device's wireless address (usually the IP address assigned when connecting to WiFi) and port number (default is 5555) from the wireless debugging page
1. Follow steps 1-2 from USB connection
2. Enter the obtained device IP address and port number in Escrcpy, then click connect device
3. At this point, Escrcpy device list should detect your phone, click start mirroring
4. Start enjoying!

### macOS && Linux

Expand Down Expand Up @@ -109,7 +121,7 @@ Refer to [scrcpy/doc/shortcuts](https://github.com/Genymobile/scrcpy/blob/master
- Switch
- Home
- Back
- Start APP
- Start APP (Mirror Group)
- Turn off screen (experimental)
- Notification
- Power
Expand All @@ -122,7 +134,6 @@ Refer to [scrcpy/doc/shortcuts](https://github.com/Genymobile/scrcpy/blob/master
- Execution Script
- Scheduled Task
- Gnirehtet
- Mirror Group (discard)

## Preferences

Expand Down Expand Up @@ -151,6 +162,7 @@ Refer to [scrcpy/doc/shortcuts](https://github.com/Genymobile/scrcpy/blob/master
- Refresh rate
- Video codec
- Display orientation
- Rotation angle
- Screen cropping
- Monitor
- Video buffer
Expand Down Expand Up @@ -239,9 +251,9 @@ Refer to [scrcpy/doc/shortcuts](https://github.com/Genymobile/scrcpy/blob/master
24. Enhanced recording ✅
25. Start APP(Multi-threaded) ✅
26. Main window edge hidden ✅
27. Improved history device connection experience 🚧
28. File management supports upload directory and progress display 🚧
29. Device grouping 🚧
27. Group devices (by filtering remarks) ✅
28. Improved history device connection experience ✅
29. File management supports upload directory and progress display 🚧
30. Game key mapping 🚧

## FAQ
Expand Down
Binary file modified screenshots/en-US/overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/ru-RU/overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/zh-CN/overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/zh-CN/phone.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/layouts/default/index.vue
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<template>
<div
class="absolute inset-0 h-full flex flex-col px-4 pt-1 space-y-4 overflow-hidden"
class="absolute inset-0 h-full flex flex-col px-4 pt-1 space-y-2 overflow-hidden"
>
<div
class="flex items-center flex-none border-b border-gray-200 dark:border-gray-700 pb-1"
Expand Down
4 changes: 2 additions & 2 deletions src/pages/device/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="h-full flex flex-col">
<BatchActions
class="overflow-hidden transition-all"
:class="isMultipleRow ? 'h-12 opacity-100' : 'h-0 opacity-0'"
:class="isMultipleRow ? 'max-h-12 opacity-100 mb-2' : 'max-h-0 opacity-0 mb-0'"
:devices="selectionRows"
/>

Expand Down Expand Up @@ -68,7 +68,7 @@
align="left"
sortable
show-overflow-tooltip
width="100"
width="150"
:filters="statusFilters"
:filter-method="filterMethod"
>
Expand Down

0 comments on commit b7629f3

Please sign in to comment.