Commit 651516a7 authored by Heather Ellsworth's avatar Heather Ellsworth Committed by Gogs

Merge branch 'master' of heather.ellsworth/developer.puri.sm into master

parents 478b8cd4 d574df04
......@@ -10,6 +10,7 @@ Design
.. toctree::
Design/Gesture
Design/Symbiotic_Apps
Design/Design_guidelines
Design/Apps_overview
Design/Shell
.. Librem 5 documentation master file, created by
sphinx-quickstart on Mon Jan 29 14:23:33 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Core Apps Overview
==================
This Core Apps section provides the foundation of apps that will be provided by Purism. These apps will work closely together to provide the basic functionality of the phone. For more information on this, see the :ref:`sym_apps` section.
All APIs developed to enable these core apps will also be publicly available and may be benificial to use when developing your own app.
.. image:: Apps_overview_pics/must_have_apps.png
:width: 320px
:height: 280px
:align: left
**Must Have Applications**
Applicatons that must be part of the Librem 5 launch in January 2019.
|
|
|
|
|
|
|
|
|
|
|
.. image:: Apps_overview_pics/nice_to_have_apps.png
:width: 320px
:height: 180px
:align: left
**Nice To Have Applications**
Applications that should ship with the Librem 5 by default but are not in the top priority of development.
|
|
|
|
|
.. image:: Apps_overview_pics/purist_services_customer_pack.png
:width: 320px
:height: 120px
:align: left
**Purist Services - Customer's Pack**
Limited (in bandwidth and storage) gratis services that will be available on the first launch of the Librem 5.
|
|
.. image:: Apps_overview_pics/purist_services_subscription.png
:width: 320px
:height: 120px
:align: left
**Purist Services - Subscription**
Additional bandwidth and/or storage for the default services + the following subscription only services.
**************
Must Have Apps
**************
**Call** (to be implemented): The Call app can handle both regular and secure (VoIP) calls.
**Messages** (to be implemented): The Messages app can handle both regular (SMS) and Secure (IM) messages.
**Mail** (`Geary <https://wiki.gnome.org/Apps/Geary>`_): The Mail app can read and send PGP encrypted emails in the most transparent way possible.
**Contacts** (`GNOME Contacts <https://wiki.gnome.org/Apps/Contacts>`_): The Contacts app details to be used by the Call, Messages, and Mail applications.
**Web** (GNOME Web aka `Epiphany <https://wiki.gnome.org/Apps/Web>`_): Simple web browser with security enhancements (PureBrowser).
**Calendar** (`GNOME Calendar <https://wiki.gnome.org/Apps/Calendar>`_): The Calendar app can sync with online calendars (like Nextcloud calendars).
**Camera** (`Cheese <https://wiki.gnome.org/Apps/Cheese>`_): The Camera app is able to take pictures and videos and is able to share them through different protocols.
**Settings** (`GNOME Settings <https://wiki.gnome.org/Design/SystemSettings/>`_): The Settings app is used to access the settings of the system as well as the settings of each application.
**Calculator** (`GNOME Calculator <https://wiki.gnome.org/Apps/Calendar>`_): A simple, easy to use calculator.
**Terminal** (`GNOME Terminal <https://wiki.gnome.org/Apps/Terminal>`_): A simple terminal to be used with a specific virtual keyboard layout including ESC and CTRL keys.
**Clocks** (`GNOME Clocks <https://wiki.gnome.org/Apps/Clocks>`_): The Clocks app includes World Clocks, Alarm, Stopwatch, and Timer features.
**Software** (`GNOME Software <https://wiki.gnome.org/Apps/Software>`_): An "App Store" including only free software to be easily installed on the system.
*****************
Nice to Have Apps
*****************
**Chess** (`GNOME Chess <https://wiki.gnome.org/Apps/Chess>`_): What would be a modern smartphone without a game?
**Weather** (`GNOME Weather <https://wiki.gnome.org/Apps/Weather>`_): Weather forecast for different locations.
**Maps** (to be implemented): Maps application with a directions feature.
**To Do** (`GNOME To Do <https://wiki.gnome.org/Apps/Todo>`_): A task list application that can be synced with online data sources like Nextcloud.
**Photos** (`GNOME Photos <https://wiki.gnome.org/Apps/Photos>`_): A Photos application to organize, edit, and share photos.
**Music** (`GNOME Music <https://wiki.gnome.org/Apps/Music>`_): A music player to organize and play many kinds of music files.
**Videos** (GNOME Videos aka `Totem <https://wiki.gnome.org/Apps/Videos>`_): A video player to browse and play many kinds of video files.
**Social** (to be implemented): Social is a Mastodon client.
***************
Purist Services
***************
Purist Services is a suite of no-knowledge free software online services that are all accessible through a single account and tightly integrated with PureOS through different applications.
These services can also be self-hosted in a decentralized manner.
Customer's Pack
---------------
The "Customer's Pack" includes all the gratis services that are available on the first launch of the Librem. These services have some limitations in bandwidth and storage (because they are gratis), but are available to anyone, including users on other devices.
Librem customers can choose not to use the services from Purism and may decide to setup their applications with different service providers or even setup the Purist services on their own server.
**Calling** (`Matrix <https://matrix.org/blog/home/>`_): A VoIP service allowing end-to-end encryption. To be used through the "Call" application.
**Messaging** (`Matrix <https://matrix.org/blog/home/>`_): An instant messaging service allowing end-to-end encryption. To be used through the "Messages" application.
**Mail** (`IMAP <https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol>`_): The Mail service is used to define an email address that becomes the single user id through all the Purist Services. A mailbox with a limited size may be given for free as part of the Customer's Pack. To be used with the "Mail" application.
**Social** (`ActivityPub <https://activitypub.rocks/>`_): A Mastodon service for federated micro-blogging.
Subscription Services
---------------------
Additional bandwidth and/or storage is available for a monthly subscription. In addition, the following services are available only by subscription. These can also be used on any platform (with compatible clients).
**Backup** (`Nextcloud <https://nextcloud.com/>`_): Keep regular encrypted backups on a remote server and and restore in the event of a disaster.
**Synchronization** (`Nextcloud <https://nextcloud.com/>`_): Synchronize your data across devices.
**VPN** (`OpenVPN <https://openvpn.net/>`_): A VPN tunnel to privacy when using non-provate networks (hotels, airports).
Design Guidelines
=================
.. toctree::
Design_guidelines/Ethical
Design_guidelines/Symbiotic_Apps
Design_guidelines/Touch
Ethical Design
==============
**We Practice Ethical Design**
*ind.ie/ethical-design*
**Human Rights** - Technology that respects human rights is
decentralised, peer-to-peer, zero-knowledge, end-to-end
encrypted, free and open source, interoperable, accessible, and
sustainable.
It respects and protects your civil liberties, reduces inequality,
and benefits democracy.
**Human Effort** - Technology that respects human effort is
functional, convenient, and reliable.
It is thoughtful and accommodating; not arrogant or
demanding. It understands that you might be distracted or
differently-abled. It respects the limited time you have on this
planet.
**Human Experience** - Technology that respects human
experience is beautiful, magical, and delightful.
It just works. It’s intuitive. It’s invisible. It recedes into the
background of your life. It gives you joy. It empowers you with
superpowers. It puts a smile on your face and makes your life
better.
To read more about our our feelings on ethical design, take a look at `this blog post <https://puri.sm/posts/we-love-ethical-design/>`_.
......@@ -3,6 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. _sym_apps:
Symbiotic Apps
==============
......
Touch Guidelines
================
Purism Touch (PT) framework is new visual language for
touch screen devices that shares visual principles of Gnome
Desktop and reflects it to new context of mobile devices
running Free & OpenSource OperatingSystem PuriOS.
.. image:: gesture_pics/p1f1.png
:width: 400px
:height: 700px
:align: left
|pic1| |pic2|
.. |pic1| image:: gesture_pics/p2f1.png
:width: 300px
:height: 550px
.. |pic2| image:: gesture_pics/p2f2.png
:width: 300px
:height: 550px
**Single hand guesture range**
Average thumb movement confortable reach.
Majority of users prefer use one hand for
interacting with mobile apps and system
interface. The position of a action target with
respect to the thumb radius impacts
performance and general experience of touch
interface.
**Touch Target Area**
Regarding action targets like links, buttons,
sliders and other UI elements, comfortable
space would not be less than physical square
7x7 - 9x9mm and cozy space of 14x14mm.
.. Librem 5 documentation master file, created by
sphinx-quickstart on Mon Jan 29 14:23:33 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Gesture Control Hot Edges
=========================
*******************
PureTouch Framework
*******************
Purism Touch (PT) framework is new visual language for
touch screen devices that shares visual principles of Gnome
Desktop and reflects it to new context of mobile devices
running Free & OpenSource OperatingSystem PuriOS.
.. image:: gesture_pics/p1f1.png
:width: 400px
:height: 700px
:align: left
**Human Experience Design and Interface**
Elements of PureTouch (PT) Framework give sense of
cleanliness and weightlessness. Color neutrality of PT Interface
Design can help every individual to express their personality by
choosing colors, gradients and images that can help co-create
their device’s idetity.
PureTouch UI aims to create a "haiku" effect and declare the
beauty of minimalism.
**We Practice Ethical Design**
*ind.ie/ethical-design*
**Human Rights** - Technology that respects human rights is
decentralised, peer-to-peer, zero-knowledge, end-to-end
encrypted, free and open source, interoperable, accessible, and
sustainable.
It respects and protects your civil liberties, reduces inequality,
and benefits democracy.
**Human Effort** - Technology that respects human effort is
functional, convenient, and reliable.
It is thoughtful and accommodating; not arrogant or
demanding. It understands that you might be distracted or
differently-abled. It respects the limited time you have on this
planet.
**Human Experience** - Technology that respects human
experience is beautiful, magical, and delightful.
It just works. It’s intuitive. It’s invisible. It recedes into the
background of your life. It gives you joy. It empowers you with
superpowers. It puts a smile on your face and makes your life
better.
|pic1| |pic2|
.. |pic1| image:: gesture_pics/p2f1.png
:width: 300px
:height: 550px
.. |pic2| image:: gesture_pics/p2f2.png
:width: 300px
:height: 550px
**Single hand guesture range**
Average thumb movement confortable reach.
Majority of users prefer use one hand for
interacting with mobile apps and system
interface. The position of a action target with
respect to the thumb radius impacts
performance and general experience of touch
interface.
**Touch Target Area**
Regarding action targets like links, buttons,
sliders and other UI elements, comfortable
space would not be less than physical square
7x7 - 9x9mm and cozy space of 14x14mm.
******************************
L5 Gesture Control - Hot Edges
******************************
Main Navigation principles with L5 PureTouch
.. image:: gesture_pics/p3f1.png
:width: 700px
:height: 650px
:align: center
+-----------------------------+-------------------------------+-------------------------------+
| **(N) Notify caption list** | **(S) List of all Setting** | **(Q) Quick Settings Widget** |
+=============================+===============================+===============================+
| | Swipe with pointing | | Swipe with pointing finger | | Thumb swipe to the left to |
| | finger down to pull down | | to pull down list of | | pull out the list of |
| | list of notifications | | notifications | | frequently used settings |
+-----------------------------+-------------------------------+-------------------------------+
+-----------------------------+-------------------------------+-------------------------------+
| **(W) Custom Widget** | **(A) Active Application** | **(H) Home Screen** |
+=============================+===============================+===============================+
| | Thumb swipe from left to | | Thumb tap middle bottom | | Thumb swipe up from bottom |
| | pull out quick contact | | ~3" and pull left/right | | to close app and get back |
| | list or other widget | | slider to navigate | | to home screen |
+-----------------------------+-------------------------------+-------------------------------+
*****************
Custom Widget (W)
*****************
Frequently used Contacts or widget of choice
|pic3| |pic4| |pic5|
.. |pic3| image:: gesture_pics/p4f1.png
:width: 220px
:height: 400px
.. |pic4| image:: gesture_pics/p4f2.png
:width: 220px
:height: 400px
.. |pic5| image:: gesture_pics/p4f3.png
:width: 220px
:height: 400px
..
+---------------------------------+----------------------------+--------------------------+
| **(W) Custom Widget: Contacts** | **Press and hold or tap** | | **(W) Custom Widget:** |
| | | | **StockExchange** |
+=================================+============================+==========================+
| | | | Tap on contact image to | | Thumb swipe from left |
| | Thumb swipe from left to pull | | go to contact details, | | to pull out your custom|
| | out your quick contact widget | | or tap and hold to | | widget |
| | | | extend actions | | |
+---------------------------------+----------------------------+--------------------------+
********************************
ActiveApps and Home Screen (A,H)
********************************
Single heand gestures to navigate
|pic6| |pic7|
.. |pic6| image:: gesture_pics/p5f1.png
:width: 300px
:height: 550px
.. |pic7| image:: gesture_pics/p5f2.png
:width: 300px
:height: 550px
+----------------------------------------+---------------------------------------+
| **(A) Navigate Active Apps** | **(H) Back to Home Screen** |
+========================================+=======================================+
| | Thumb tap middle bottom ~3" and | | Thumb swipe up from bottom to close |
| | pull left/right slider to navigat | | app and get back to home screen |
+----------------------------------------+---------------------------------------+
*******************
Settings List (S,N)
*******************
Frequently used Contacts or widget of choice
|pic8| |pic9|
.. |pic8| image:: gesture_pics/p6f1.png
:width: 300px
:height: 550px
.. |pic9| image:: gesture_pics/p6f2.png
:width: 300px
:height: 550px
+---------------------------------------------+---------------------------------------+
| **(S) List of all Settings** | **(N) Notification List** |
+=============================================+=======================================+
| | Swipe with pointing finger to | | Swipe with pointing finger to pull |
| | pull down settings lis | | down list of notifications |
+---------------------------------------------+---------------------------------------+
***********
Lock Screen
***********
.. image:: gesture_pics/p7f1.png
:width: 700px
:height: 650px
:align: center
+-----------------------------------+-----------------------------------+
| **(N) Notification List** | **(S) List of all Settings** |
+===================================+===================================+
| | Swipe with pointing finger to | | Swipe with pointing finger |
| | pull down list of notifications | | to pull down setting list |
+-----------------------------------+-----------------------------------+
+--------------------------------------+--------------------------------------+
| **(R) Reminders and Notifications** | **(F) Forecast** |
+======================================+======================================+
| | Swipe left/right to see upcoming | | Swipe right to see future forecast |
| | calendar events and notifications | | |
+--------------------------------------+--------------------------------------+
|pic10| |pic11|
.. |pic10| image:: gesture_pics/p8f1.png
:width: 300px
:height: 550px
.. |pic11| image:: gesture_pics/p8f2.png
:width: 300px
:height: 550px
.. image:: gesture_pics/p9f1.png
:width: 700px
:height: 500px
:align: center
+------------------------------+----------------------------+-------------------------------------+
| **(I) Frequently used Apps** | **(T) Active Processes** | **(P) Apps Running in background** |
+==============================+============================+=====================================+
| | Swipe up to extend list to | | Active call or music | | Beside bottom center action to |
| | full list of installed | | playing would be | | list active apps, tap on this |
| | apps | | presented as widget | | second way |
+------------------------------+----------------------------+-------------------------------------+
+--------------------------------------+----------------------------------------+
| **(F) Finder, Browser address bar** | **(H) Home Screen** |
+======================================+========================================+
| | Search the web or open web | | Thumb swipe up from bottom to close |
| | address by typing like "puri.sm" | | app list and get back to home screen |
+--------------------------------------+----------------------------------------+
.. Librem 5 documentation master file, created by
sphinx-quickstart on Mon Jan 29 14:23:33 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Phone Shell
===========
This is the design of the phone shell, called :ref:`phosh`.
Starting from the leftmost picture, you can start to get a feel for the stages to be expected on the phone through the various states.
.. image:: shell_pics/shell.jpg
:width: 700px
:height: 500px
:align: center
The leftmost picture shows the lockscreen where the user will need to "Slide up to unlock".
Then after the user slides up, they will see the dialpad with some text prompting the user to "Insert your passcode". When the user begins to input the passcode, the dots represent the secret values entered.
Once the screen is successfully unlocked, the user will be taken to the home screen which is a matrix of applications. Note that the current image contains redundant placeholder applications.
The user will open up an application that will be full screen with two additional interactive points: can slide down from the top or tap the bottom bar to return to the home application screen. The "Power off" screen is also displayed in this picture along with a mockup onscreen keyboard.
Finally, the rightmost image displays what an incoming phone call will look like.
......@@ -10,5 +10,5 @@ Environments
.. toctree::
Environments/Shell
Environments/Phosh
Environments/PlasmaMobile
.. index:: phosh
.. index:: shell
.. _phosh:
Shell
Phosh
=====
The Phone's shell Phosh is based on GNOME_ technologies (GTK+,
GSettings, DBus) and uses a patched rootston_ as Wayland compositor.
.. image:: Shell/images/phosh.jpg
.. image:: Phosh/images/phosh.jpg
:width: 400px
.. toctree::
Shell/Install
Phosh/Install
.. _rootston: https://github.com/swaywm/wlroots
.. _GNOME: https://developer.gnome.org
......@@ -5,8 +5,8 @@
.. _volunteering:
Volunteering
============
Community
=========
.. toctree::
......
......@@ -30,9 +30,9 @@ Welcome to the Librem 5 documentation! This site contains instruction and exampl
Directory
*********
* :ref:`design` - Take a look at the expected look and feel of the Librem 5 phone
* :ref:`phosh` - Learn how to setup the wlroots-based phone shell
* :ref:`plamo` - Walkthrough to setup Plasma Mobile
* :ref:`app_development` - Find out all abnout how to make, build, deploy, and publish apps.
* :ref:`volunteering` - Find out how you can get involved and improve the project
* :ref:`resources` - Useful external resources
* :ref:`design` (to be implemented) - Take a look at the expected look and feel of the Librem 5 phone. As an app developer, you can get an idea of how apps fit into the overall user interface.
* :ref:`phosh` - Learn how to setup the wlroots-based phone shell for development.
* :ref:`plamo` - Walkthrough to setup Plasma Mobile.
* :ref:`app_development` - Find out all about how to make, build, deploy, and publish applications.
* :ref:`volunteering` - Find out how you can get involved and help improve the project.
* :ref:`resources` - Useful external resources.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment