peterbrittain/asciimatics

Developer documentation

Open

#38 创建于 2016年8月12日

在 GitHub 查看
 (2 评论) (1 反应) (0 负责人)Python (3,479 star) (244 fork)batch import
Documentationhelp wanted

描述

There are some aspects of the design that should be documented in a little more detail, but they don't naturally fall in the user guide. For example:

  1. Internals of Windows/Curses Screens
  2. Formal internal API for Effects and Scenes.
  3. Frame skipping for refresh (in order to reduce CPU)

This should be fleshed out into a proper developer guide.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Python knowledgeUnderstanding of asciimatics internals
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
Explore the asciimatics codebase, focusing on the Windows/Curses screens implementation, the Effects and Scenes API, and the frame skipping logic. Review any existing documentation in the repository. Write a developer guide covering these topics, referencing source files like screens.py, effects.py, and scenes.py.