Commit 1049d1e0 authored by David Boddie's avatar David Boddie

Further reorganization to allow chapters to be expanded later.

Signed-off-by: David Boddie's avatarDavid Boddie <david.boddie@puri.sm>
parent c9a46d48
......@@ -3,8 +3,15 @@
API Docs
========
This page lists phone/Librem-5 specific API documentation. For links
to upstream documentation check also :ref:`resources`.
This chapter contains API documentation specific to the Librem 5 as well as
links to upstream documentation.
API documentation for the underlying GNOME platform can be found in
:ref:`gnome_resources`.
See also the :ref:`software_reference` for detailed information about the
Librem 5 software stack.
Phone/Messaging APIs
--------------------
......
......@@ -8,9 +8,13 @@ App Development
Apps/Constraints
Apps/Gnome
Apps/Kde
Apps/Design
Apps/PublishingApps
If you are interested in app development then you're in the right place! Here, you can find out how to make, build, deploy, and publish apps for distributing. Take a look at the flow charts below to get a visual idea of the layout of this apps section.
If you are interested in app development then you're in the right place! Here,
you can find out how to make, build, deploy, and publish apps for distributing.
Take a look at the flow charts below to get a visual idea of the layout of this
apps section.
|pic1| |pic2|
......@@ -29,7 +33,8 @@ First determine which phone environment you want to integrate with:
For more information, see :ref:`environments`.
Your environment will determine which tools and languages are available to you for app development.
Your environment will determine which tools and languages are available to you
for app development.
Next, what kind of application format would you like?
......@@ -44,8 +49,9 @@ You can follow the above charts to determine the IDE/build tool suggested.
* :ref:`qt` provides QtCreator and QtDesigner, good tools for designing Qt based UIs
* For building a deb package, `git-buildpackage <http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.html>`_ is the preferred build method
Once your app is ready to be distributed to other developers, you can submit your app for inclusion.
Once your app is ready to be distributed to other developers, you can submit
your app for inclusion.
* There will be a flatpak repository for only free software flatpaks. This repository will be hosted by PureOS
* There will be a flatpak repository for only free software flatpaks. This
repository will be hosted by PureOS
* To submit your app for inclusion into Debian, follow `standard Debian package submission procedures <https://www.debian.org/doc/manuals/distribute-deb/distribute-deb.html#adding-packages-to-debian>`_
......@@ -31,7 +31,7 @@
GTK+
====
`GTK+ <GTK+ website_>`_ is the graphical application framework used to develop all GNOME applications. This section presents tips and tricks with GTK+ to help you develop great adaptive applications for GNOME, for general GTK+ and GNOME development resources please check the :ref:`resources` page.
`GTK+ <GTK+ website_>`_ is the graphical application framework used to develop all GNOME applications. This section presents tips and tricks with GTK+ to help you develop great adaptive applications for GNOME, for general GTK+ and GNOME development resources please check the :ref:`gnome_resources` page.
libhandy_ is a widget library for GTK+. It contains widgets useful for both phone applications and adaptive applications and it is going to be used in that page as an extension to GTK+.
......
.. _gnome_resources:
GTK+/GNOME Resources
====================
When developing an application for the GNOME environment running on a Librem 5
phone, the following resources may contain useful information and advice:
* `GNOME developer center <https://developer.gnome.org/>`_
* `Introducton to GObject <https://blogs.gnome.org/desrt/2012/02/26/a-gentle-introduction-to-gobject-construction/>`_
* `HowDoI things in GNOME <https://wiki.gnome.org/HowDoI/>`_
* `GNOME API Reference <https://developer.gnome.org/references>`_
......@@ -11,4 +11,4 @@ GNOME
GNOME/GBuilder
GNOME/Gtk+
GNOME/Glade
GNOME/Resources
......@@ -3,25 +3,37 @@
Getting in Touch
================
It is common to receive questions like "Will the Librem 5 support _____?" or "Is anyone working on adding support for _____ because I want to help?"
.. toctree::
Volunteering
Contributing
Issues
FAQ
If you have questions about anything regarding the Librem 5, we would really like to hear them from you and there are a couple of recommended ways to reach out:
It is common to receive questions like "Will the Librem 5 support _____?" or
"Is anyone working on adding support for _____ because I want to help?"
There are a couple of ways to contact us and join the fun. We have email lists that are quiet now but will be lively once the dev kits have been sent out. We also have Matrix chat rooms where other volunteers hang out as well as many people from the Purism team. Both places are great locations to introduce yourself and ask questions.
If you have questions about anything regarding the Librem 5, we would really
like to hear from you and there are a couple of recommended ways to contact us
and join the fun. We have email lists that are quiet now but will be lively
once the dev kits have been sent out. We also have Matrix chat rooms where other volunteers hang out as well as many people from the Purism team. Both places are great locations to introduce yourself and ask questions.
.. _email-lists:
Email Lists
###########
Watch technical email regarding ongoing software development within the team and feel free to chime in with good suggestions. Depending on the level of involvement that you're seeking, you can sign up for any/all of these email lists where you can follow development and ask questions:
Watch technical email regarding ongoing software development within the team
and feel free to chime in with good suggestions. Depending on the level of
involvement that you're seeking, you can sign up for any/all of these email
lists where you can follow development and ask questions:
* `librem-5-announce@lists.community.puri.sm <https://lists.community.puri.sm/listinfo/librem-5-announce>`_ : General Librem 5 announcements (low volume, read only)
* `librem-5-dev@lists.community.puri.sm <https://lists.community.puri.sm/listinfo/librem-5-dev>`_ : For all sorts of development conversations. This list will be very technical in nature so join the fun!
* `librem-5-users@lists.community.puri.sm <https://lists.community.puri.sm/listinfo/librem-5-users>`_ : For general users of the Librem 5 that are not so interested in the nitty gritty technical details. This list will contain light traffic until the Librem 5 ships in January 2019.
* `all@lists.community.puri.sm <https://lists.community.puri.sm/listinfo/all>`_ : All announcements to all community members
For the mailing lists, there is no account setup required. Just subscribe, see a full list `here <https://lists.puri.sm/>`_.
For the mailing lists, there is no account setup required. Just subscribe, see
a full list `here <https://lists.puri.sm/>`_.
.. _matrix-chat-rooms:
......@@ -38,7 +50,11 @@ Community rooms for non-Librem 5 discussions:
* `community/purist <https://matrix.to/#/#community-purist:talk.puri.sm>`_ (ID !RkGDRtKCBzjnWMEGMV:talk.puri.sm) : For Purist Services
* `community/general <https://matrix.to/#/#community-general:talk.puri.sm>`_ (ID !aXWDJNTtEfhSXdPoQT:talk.puri.sm) : For questions that are not obviously related to the Librem 5, PureOS, or Purist Services
If you do not already have a Matrix account, please visit `Matrix's website <https://matrix.org>`_ to choose a Matrix client where you can register. Once you have a registered Matrix account, you should log into the default matrix.org server where you can search for our community Matrix rooms on our talk.puri.sm Matrix server.
If you do not already have a Matrix account, please visit `Matrix's website
<https://matrix.org>`_ to choose a Matrix client where you can register. Once
you have a registered Matrix account, you should log into the default matrix.org
server where you can search for our community Matrix rooms on our talk.puri.sm
Matrix server.
Example: To find the community/librem-5 room, you should search for #community-librem-5:talk.puri.sm
......
......@@ -7,3 +7,4 @@ Setting up a Development Environment
Development_Environment/Requirements.rst
Development_Environment/Boards.rst
Development_Environment/Workstation.rst
.. _boards:
Development Boards
==================
Development Kits
================
The development boards for the Librem 5 are built around the
`EmCraft i.MX 8M SoM <https://www.emcraft.com/products/868>`_, a development
......
.. workstation:
Workstation
===========
Application development for the Librem 5 is not tied to a particular set of
technologies. However, for simplicity, we recommend that you use the same set
of tools and libraries that the Librem 5 developers have used.
* GNOME technologies: A run through the various GNOME technologies.
* GNOME Builder documentation: Documentation for the GNOME IDE.
* Meson: The recommended build system.
* Flatpak: Application sandboxing and distribution.
* gitg: The GNOME git client.
.. index:: Software Reference
.. _software_reference:
Software Reference
==================
This chapter provides information about the software components used in the
Librem 5 stack and includes links to useful external resources.
.. toctree::
Software_Reference/Environments
Software_Reference/Wayland
.. index:: Development Resources
.. _resources:
Development Resources
=====================
This page provides links to useful external resources.
GTK+/GNOME
----------
When developing an application for GNOME or GTK+ or working on the shell these links might be useful:
* `GNOME developer center <https://developer.gnome.org/>`_
* `Introducton to GObject <https://blogs.gnome.org/desrt/2012/02/26/a-gentle-introduction-to-gobject-construction/>`_
* `HowDoI things in GNOME <https://wiki.gnome.org/HowDoI/>`_
.. _wayland:
Wayland
-------
=======
When working on the compositor these links might be useful:
* `Wayland architecture <https://wayland.freedesktop.org/architecture.html>`_
......
......@@ -19,14 +19,9 @@ examples to help you accomplish your goals with the Librem 5 dev kit and phone.
Development_Environment
Apps
APIs
Design
Volunteering
Contributing
Resources
Contact
FAQ
Issues
History
Software_Reference
Hardware_Reference
Appendix
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