~aleteoryx/muditaos

274812504d2755782a33a5f8ac25b86e6816253e — Wojtek Cichon 4 years ago 6fdcdbd
[EGD-6238] Write Pure simulator guide

Added a simple Pure simulator guide to the docs.
3 files changed, 18 insertions(+), 1 deletions(-)

M doc/README.md
M doc/host_keyboard_bindings.md
A doc/howto_simulator.md
M doc/README.md => doc/README.md +2 -0
@@ 35,7 35,9 @@ firefox build/doc/html/index.html
- [Setting up integrated development environment](setup_ide.md)
- [Test harness](../test/README.md)
- [Running MuditaOS on a phone](running_on_phone.md)
- [Windows and macOS - flashing Pure with image](flashing_win_macos.md)
- [GUI](../module-gui/README.md)
- How to use Mudita Pure simulator(howto_simulator.md)
- [Keybindings on Linux](host_keyboard_bindings.md)
- [Development workflow](development_workflow.md)
    - [Creating release](release.md)

M doc/host_keyboard_bindings.md => doc/host_keyboard_bindings.md +1 -1
@@ 1,4 1,4 @@
# Keyboard bindinging on Linux
# Keyboard binding on Linux Pure simulator

## Table of contents


A doc/howto_simulator.md => doc/howto_simulator.md +15 -0
@@ 0,0 1,15 @@
# How to use Mudita Pure phone simulator

Mudita Pure phone simulator is a tool created to speed up developer work. Despite its limitations it's a good introduction to Mudita Pure GUI and selected apss and funcionalities of MuditaOS.

Some of the differences between the simulator and the actual phone are:
- you can't make phone calls or send text messages (unless you have a connected development board)
- it doesn't work fully as on the phone i.e. there are no visible E-Ink refreshes

You can start the simulator locally by executig the `PurePhone.elf` file located inside your build directory. 

You can also run the simulator on disk image with the same layout as we got on the phone by using `run_emulator_on_filesystem_image.sh`.

To move around the simulator please use the ["Keyboard binding on Linux Pure simulator" document](host_keyboard_bindings.md).

[![Mudita Pure Simulator](https://res.cloudinary.com/marcomontalbano/image/upload/v1616080178/video_to_markdown/images/google-drive--1qxRZMRJ2j6I4ilaF_77N4YQoiLoAdK9c-c05b58ac6eb4c4700831b2b3070cd403.jpg)](https://drive.google.com/file/d/1qxRZMRJ2j6I4ilaF_77N4YQoiLoAdK9c/view?usp=sharing "Mudita Pure Simulator")
\ No newline at end of file