Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.82 KB

getting-started.md

File metadata and controls

54 lines (37 loc) · 1.82 KB
Raw

Getting Started with Screen 13

This guide is intended for developers who are new to Screen 13 and want a step-by-step introduction. For further details on these topics refer to the online documentation.

Required Packages

Linux (Debian-like):

  • sudo apt install cmake uuid-dev libfontconfig-dev libssl-dev

Mac OS (10.15 or later):

  • Xcode 12
  • Python 2.7
  • brew install cmake ossp-uuid

Windows:

  • TODO (works but I haven't gathered the requirements)

Documentation

Read the generated documentation online, or run the following command locally:

cargo doc --open

Changes

Stay informed of recent changes to Screen 13 using the change log file.

Performance Profiling

Most of the example code (the ones which use an EventLoop) support profiling using puffin. To use it, first install and run puffin_viewer and then run the example with the --features profile-with-puffin and --release flags.

You may need to disable CPU thermal throttling in order to get consistent results on some platforms. The inconsistent results are certainly valid, but they do not help in accurately measuring potential changes. This may be done on Intel Linux machines by modifying the Intel P-State driver:

echo 100 | sudo tee /sys/devices/system/cpu/intel_pstate/min_perf_pct

(Source)

Helpful tools