Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
vince-hz committed Nov 10, 2023
1 parent 8b0bf86 commit 72c7309
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 18 deletions.
13 changes: 3 additions & 10 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,21 +296,14 @@ Native端在使用自定义App时需要注册对应的App到SDK中。

## 使用YYKit

本SDK默认依赖为YYModel,部分使用者若使用YYKit,依赖关系将会发生错误。

解决方法为修改Podfile:

``` ruby
pod 'Whiteboard/Whiteboard-YYKit'
```
如果你的项目中使用了 YYKit ,那么会跟我们的库依赖关系发生冲突。由于 YYKit 在 Xcode 15.0 后使用极度不便,建议选用其他替代库。

## 部分问题

1. 目前 SDK 关键字为`White`,未严格使用前置三大写字母做前缀。
2. 在白板内容比较复杂的情况下,白板有可能会因为内存不足的原因被系统kill掉,导致白屏,我们在 2.16.30 的版本中对该情况进行了主动恢复。在 2.16.30 的版本前,可以通过设置 `WhiteBoardView``navigationDelegate` 来监听 `webViewWebContentProcessDidTerminate:` 方法。当白板被kill掉时,会调用该方法,你可以在该方法中提示用户重新连接以恢复白板。
3. 关于 cocoapods 发版:由于项目中的一些子仓库依赖了一些不支持arm64-simulator的静态库,比如 `YYKit` ,导致 pod lint 无法通过。 目前的解决办法是修改本地的 `validator.rb` 文件。具体参考 [这里](https://github.com/caixindong/Cocoapods_fix_i386/blob/master/validator.rb)
4. 由于使用的场景存在较多可能性,第三方代码的引用方式请使用条件判断的方式来引入,比如 `#import "YYModel.h"` 需要替换成 `#if __has_include(<YYModel/YYModel.h>) #import <YYModel/YYModel.h>`.
5. 从 2.16.63 版本开始,fpa加速停止提供服务。
3. 由于使用的场景存在较多可能性,第三方代码的引用方式请使用条件判断的方式来引入,比如 `#import "YYModel.h"` 需要替换成 `#if __has_include(<YYModel/YYModel.h>) #import <YYModel/YYModel.h>`.
4. 从 2.16.63 版本开始,fpa加速停止提供服务。

## Whiteboard - Framework 拖拽方式集成

Expand Down
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,18 +291,13 @@ Please call this method to complete the initialization of `WhiteAppParam`
## Using YYKit
The default dependency of this SDK is YYModel, some users will have an error in the dependency if they use YYKit.
If you use YYKit in your project, it will conflict with our library dependencies. Since YYKit is extremely difficult to use after Xcode 15.0, we recommend using an alternative library.
The solution is to modify the Podfile:
``` ruby
pod 'Whiteboard/Whiteboard-YYKit'
```

## Part of the problem

1. The current SDK keyword is 'White', which is not strictly prefixed by three uppercase letters.
2. In case of complex content, the WhiteBoard may be killed by the system due to lack of memory, resulting in a white screen, we have restored this situation in version 2.16.30. Before 2.16.30, you can set `navigationDelegate` of `WhiteBoardView` to listen to `webViewWebContentProcessDidTerminate:` method. This method will be called when the whiteboard is killed and you can prompt the user to reconnect to resume the whiteboard in this method.
3. About cocoapods release: Some subspecs in the project depend on static libraries that do not support arm64-simulator architecture, such as `YYKit`, which cause the pod lint to fail. The current workaround is to modify the local `validator.rb` file. See [here](https://github.com/caixindong/Cocoapods_fix_i386/blob/master/validator.rb) for details.
4. Due to the possibility of using scenarios, please use conditional references to third-party code, for example `#import "YYModel.h"` needs to be replaced with `#if __has_include(<YYModel/YYModel.h>) #import <YYModel/YYModel.h> `.
5. Starting with version 2.16.63, fpa acceleration is no longer available.
3. Due to the possibility of using scenarios, please use conditional references to third-party code, for example `#import "YYModel.h"` needs to be replaced with `#if __has_include(<YYModel/YYModel.h>) #import <YYModel/YYModel.h> `.
4. Starting with version 2.16.63, fpa acceleration is no longer available.

0 comments on commit 72c7309

Please sign in to comment.