Commit 39816396 authored by David Boddie's avatar David Boddie

Reorganized the Getting In Touch chapter.

Moved the History chapter into the Introduction chapter.
parent 1049d1e0
......@@ -3,66 +3,15 @@
Getting in Touch
================
.. toctree::
Volunteering
Contributing
Issues
FAQ
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?"
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:
* `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/>`_.
.. _matrix-chat-rooms:
Matrix Chat Rooms
#################
The following sections contain all you need to know to get involved with the
Librem 5 project, from participating in discussions to submitting bug reports
and patches.
Join our Matrix chat rooms using your Matrix login:
Librem 5 specific:
* `community/librem-5 <https://matrix.to/#/#community-librem-5:talk.puri.sm>`_ (ID !BSqRHgvCtIsGittkBG:talk.puri.sm) : For Librem 5 development chatter
Community rooms for non-Librem 5 discussions:
* `community/pureos <https://matrix.to/#/#community-pureos:talk.puri.sm>`_ (ID !bGtSETqkYFOebMtlfH:talk.puri.sm) : For discussions around PureOS in general
* `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.
Example: To find the community/librem-5 room, you should search for #community-librem-5:talk.puri.sm
If you have any issues finding our Matrix rooms, please email admins@puri.sm with your Matrix id and they will make sure you get invited to the rooms (although invitations are not necessary for access).
Once you have access to the Matrix channels, please say "Hi" and introduce yourself. Let us know who you are and what areas of development interest you the most so that we can guide you to the right resources for your development.
Code Repositories
#################
Our `code repos <https://source.puri.sm/>`_ are where anyone can register an account to view our repositories, create your own, file issues, and submit pull requests.
.. toctree::
Contact/Community
Contact/Volunteering
Contact/Contributing
Contact/Issues
.. _community:
Community
=========
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:
* `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/>`_.
.. _matrix-chat-rooms:
Matrix Chat Rooms
-----------------
Join our Matrix chat rooms using your Matrix login:
Librem 5 specific:
* `community/librem-5 <https://matrix.to/#/#community-librem-5:talk.puri.sm>`_ (ID !BSqRHgvCtIsGittkBG:talk.puri.sm) : For Librem 5 development chatter
Community rooms for non-Librem 5 discussions:
* `community/pureos <https://matrix.to/#/#community-pureos:talk.puri.sm>`_ (ID !bGtSETqkYFOebMtlfH:talk.puri.sm) : For discussions around PureOS in general
* `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.
Example: To find the community/librem-5 room, you should search for #community-librem-5:talk.puri.sm
If you have any issues finding our Matrix rooms, please email admins@puri.sm with your Matrix id and they will make sure you get invited to the rooms (although invitations are not necessary for access).
Once you have access to the Matrix channels, please say "Hi" and introduce yourself. Let us know who you are and what areas of development interest you the most so that we can guide you to the right resources for your development.
Code Repositories
-----------------
Our `code repos <https://source.puri.sm/>`_ are where anyone can register an account to view our repositories, create your own, file issues, and submit pull requests.
......@@ -23,7 +23,7 @@ Repository Guidelines
If you have a repository that you maintain but expect others to contribute to, then it is helpful for newcomers to know who to contact when they have questions regarding that repository. For this reason, we would like every repository to contain a `doap <https://en.wikipedia.org/wiki/DOAP>`_ file with the maintaner field filled out. Optionally, if you know of someone that will regularly review your merge requests, then the helper field should also be completed. For a list of supported doap fields, see `this list on Wikipedia <https://en.wikipedia.org/wiki/DOAP>`_ but below is complete example you can modify to match your project:
.. literalinclude:: examples/doap.xml
.. literalinclude:: ../examples/doap.xml
:language: XML
Be sure to adapt the above template to match your project info.
......
.. _howto:
.. _volunteering:
Volunteering
============
Are you as excited about the Librem 5 phone as we are?! So excited you *NEED* to volunteer? Well we are excited to welcome you to a community of like minded people!
***************
The Common Goal
***************
---------------
Together, we want to improve PureOS for the Librem 5 and there are several ways in which you can help.
......@@ -22,9 +21,9 @@ Whether it be porting/writing apps, finding defects, writing tutorials, or anyth
Note: To include your app in PureOS, please see :ref:`Publishing-Apps`
**************************************
Getting your own puri.sm email account
**************************************
--------------------------------------
If you do not trust the common email providers such as Google, Hotmail, Yahoo, etc. and would like your own email address hosted by us, you can request an @community.puri.sm email account. Just send us an email: admins@puri.sm and we'll get you all setup with your @community.puri.sm email account. Be sure to include the following in your email:
* Full name
......
......@@ -3,3 +3,57 @@
Hardware Reference
==================
This chapter contains a description of the hardware included with the Librem 5
developer kit and phone. The following list is a placeholder that will be
replaced with individual sections. It is based on the information about the
developer kits contained in `this blog post <https://puri.sm/posts/librem5-2018-11-hardware-report/>`.
* 10/100 Ethernet
* Audio Codec
* Bluetooth I2S interface
* Bluetooth (UART4)
* Camera (MIPI CSI)
* Charge Controller
* Charge controller's thermistor
* Display's LED backlight
* Earpiece speaker
* eMMC boot (boot mode switch in the "up" position)
* External microphone
* GNSS (UART interface and antenna)
* Haptic motor
* hardware kill switches for WiFi / BT and microphone
* headphones detect (HP_DET)
* Headphone speakers
* Headset microphone
* IMU (accelerometer, gyro, magnetometer)
* JTAG
* Microphone select IC
* Mini-HDMI
* MIPI DSI LCD panel
* On-board microphone
* Power indicator LEDs
* Powering from 18650 battery
* Proximity / ambient light sensor
* push buttons (power button, reset button, volume up, volume down)
* RedPine WiFi/BT M.2 module on SDIO
* RTC
* Safely charging an 18650 battery
* Serial Downloader (loading u-boot via USB)
* Smart card reader and smart card slot
* SoM (pinout mostly validated, SoC, eMMC, and PMIC working)
* SPI NOR Flash
* Touch controller
* UART Debug
* USB-C
* USB-C role switching
* USB Hub and SD controller
* User LED
* WLAN/BT antennae
* WWAN hardware kill switch
* WWAN I2S interface
* WWAN module, SIM card and antenna
Additional sections may also cover these components:
* Audio jacks - headphone, microphone
* Modem
......@@ -14,3 +14,7 @@ overall software architecture stack.
:width: 700px
:height: 500px
:align: center
.. toctree::
Introduction/History
.. _volunteering:
Community
=========
.. toctree::
Volunteering/HowTo
......@@ -11,7 +11,7 @@ examples to help you accomplish your goals with the Librem 5 dev kit and phone.
.. toctree::
:titlesonly:
:maxdepth: 2
:maxdepth: 1
:caption: Table of Contents
:glob:
......@@ -20,7 +20,7 @@ examples to help you accomplish your goals with the Librem 5 dev kit and phone.
Apps
APIs
Contact
History
FAQ
Software_Reference
Hardware_Reference
......
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