nice-view-gem 项目使用教程

nice-view-gem 项目使用教程

nice-view-gem A sleek customization for the nice!view shield 项目地址: https://gitcode.com/gh_mirrors/ni/nice-view-gem

1. 项目目录结构及介绍

nice-view-gem 项目目录结构如下：

nice-view-gem/
├── .github/
│   └── assets/
├── boards/
│   └── shields/
│       └── nice_view_gem/
├── .clang-format
├── .gitignore
├── LICENSE
├── README.md
└── zephyr/

• .github/: 存放 GitHub Actions 相关配置文件和资产。
• boards/: 包含键盘板配置文件。
• shields/: 存放护盾（shield）相关文件。
• .clang-format: Clang 格式化配置文件。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目使用的 MIT 许可证文件。
• README.md: 项目说明文件。
• zephyr/: 包含 Zephyr RTOS 相关文件。

2. 项目的启动文件介绍

nice-view-gem 项目的启动文件主要是通过修改 config/west.yml 文件来添加新的远程仓库和项目。以下是启动文件的基本配置：

manifest:
  remotes:
    - name: zmkfirmware
      url-base: https://github.com/zmkfirmware
    - name: m165437
      url-base: https://github.com/M165437
  projects:
    - name: zmk
      remote: zmkfirmware
      revision: main
      import: app/west.yml
    - name: nice-view-gem
      remote: m165437
      revision: main
      self: path: config

在这个配置文件中，我们添加了 m165437 作为一个新的远程仓库，并引入了 nice-view-gem 项目。

3. 项目的配置文件介绍

nice-view-gem 项目的配置文件主要用于调整护盾的行为和外观。配置文件通常位于个人配置目录中，以下是一些基本配置选项：

• CONFIG_NICE_VIEW_GEM_WPM_FIXED_RANGE: 布尔值，用于设置护盾是否使用固定的 WPM 范围。默认为 y（是）。
• CONFIG_NICE_VIEW_GEM_WPM_FIXED_RANGE_MAX: 整数，用于调整固定范围的最大值。默认为 100。
• CONFIG_NICE_VIEW_GEM_ANIMATION: 布尔值，用于设置是否启用动画效果。默认为 y（是）。
• CONFIG_NICE_VIEW_GEM_ANIMATION_MS: 整数，用于调整动画速度。默认为 960 毫秒。

以下是一个配置文件示例：

# nice_view_gem 配置文件
CONFIG_NICE_VIEW_GEM_WPM_FIXED_RANGE=y
CONFIG_NICE_VIEW_GEM_WPM_FIXED_RANGE_MAX=100
CONFIG_NICE_VIEW_GEM_ANIMATION=y
CONFIG_NICE_VIEW_GEM_ANIMATION_MS=960

通过修改这些配置，用户可以根据个人喜好和需求调整护盾的显示效果。

nice-view-gem A sleek customization for the nice!view shield 项目地址: https://gitcode.com/gh_mirrors/ni/nice-view-gem