~anjan/sxmo-docs-stable

96df188de6f66bc3ff5e62911b7c2e60912bec7a — Anjandev Momi 8 months ago b64394c
use relative links
5 files changed, 10 insertions(+), 10 deletions(-)

M CONTRIBUTING.md
M INSTALLGUIDE.md
M SYSTEMGUIDE.md
M USERGUIDE.md
M index.md
M CONTRIBUTING.md => CONTRIBUTING.md +1 -1
@@ 2,7 2,7 @@

---

[Project Overview](https://sr.ht/~mil/Sxmo) | [Install Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/INSTALLGUIDE.md) | [User Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/USERGUIDE.md) | [Contributing](https://git.sr.ht/~mil/sxmo-docs/tree/master/CONTRIBUTING.md) | [Images](https://images.postmarketos.org/bpo/) | [Demo Video](https://diode.zone/videos/watch/9651fd70-7668-4110-8e9a-211007b8509e)
[Project Overview](https://sr.ht/~mil/Sxmo) | [Install Guide](./INSTALLGUIDE.md) | [User Guide](./USERGUIDE.md) | [Contributing](./CONTRIBUTING.md) | [Images](https://images.postmarketos.org/bpo/) | [Demo Video](https://diode.zone/videos/watch/9651fd70-7668-4110-8e9a-211007b8509e)

---


M INSTALLGUIDE.md => INSTALLGUIDE.md +3 -3
@@ 2,7 2,7 @@

---

[Project Overview](https://sr.ht/~mil/Sxmo) | [Install Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/INSTALLGUIDE.md) | [User Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/USERGUIDE.md) | [Contributing](https://git.sr.ht/~mil/sxmo-docs/tree/master/CONTRIBUTING.md) | [Images](https://images.postmarketos.org/bpo/) | [Demo Video](https://diode.zone/videos/watch/9651fd70-7668-4110-8e9a-211007b8509e)
[Project Overview](https://sr.ht/~mil/Sxmo) | [Install Guide](./INSTALLGUIDE.md) | [User Guide](./USERGUIDE.md) | [Contributing](./CONTRIBUTING.md) | [Images](https://images.postmarketos.org/bpo/) | [Demo Video](https://diode.zone/videos/watch/9651fd70-7668-4110-8e9a-211007b8509e)

---



@@ 21,7 21,7 @@ selected UI.
2. Extract the image: `unxz downloaded_image.xz`
3. Write  the image to your SD card: `dd if=downloaded_image.img of=/dev/mmcblk0`
   (**Make sure to check if this is really your SD card device using ``lsblk``!**)
4. Pop the SD card into your Pinephone and see the [Userguide](https://git.sr.ht/~mil/sxmo-docs/tree/master/USERGUIDE.md)
4. Pop the SD card into your Pinephone and see the [Userguide](./USERGUIDE.md)
5. Please note, for general use, login as `user` with the lockscreen password set up during the installer. (If the installer wasn't used, the default password is `147147`).
   1. **The ssh user for the installer is only intended for login over ssh, not for logging into a graphical session**. To enable sxmo's ssh features, you can set up ssh for ``user``.
   2. login with the ssh user setup during the installer


@@ 33,7 33,7 @@ selected UI.
is proportional to the size of the SD card, so if you use a large card expect
   this to take a few minutes - this is a one-time process and subsequent boots
   will be faster.
7. After booting, make sure to check the User Guide for [instructions on how to update](https://git.sr.ht/~mil/sxmo-docs/tree/master/USERGUIDE.md#strongupdating-and-changelogstrong)
7. After booting, make sure to check the User Guide for [instructions on how to update](./USERGUIDE.md#strongupdating-and-changelogstrong)

**Alternative to step 5: Setting the ssh user from the installer as the main user instead**


M SYSTEMGUIDE.md => SYSTEMGUIDE.md +2 -2
@@ 172,10 172,10 @@ This script, located at [`/usr/sbin/sxmo_xinit.sh`](https://git.sr.ht/~mil/sxmo-
Various processes are started when certain events occur, rather than always being run at startup or login. Some of the most significant ones are listed below:

## Key and Button Presses - dwm
The keys and button presses which dwm responds to are specified at compile-time in the [`config.h`](https://git.sr.ht/~mil/sxmo-dwm/tree/master/item/config.def.h#L88) for [`sxmo-dwm`](https://git.sr.ht/~mil/sxmo-dwm). See the [userguide](https://git.sr.ht/~mil/sxmo-docs/tree/master/USERGUIDE.md#strongglobal-ui-controlsstrong) for a description.
The keys and button presses which dwm responds to are specified at compile-time in the [`config.h`](https://git.sr.ht/~mil/sxmo-dwm/tree/master/item/config.def.h#L88) for [`sxmo-dwm`](https://git.sr.ht/~mil/sxmo-dwm). See the [userguide](./USERGUIDE.md#strongglobal-ui-controlsstrong) for a description.

## Screen Gestures - lisgd
The built-in responses to screen gestures that are specified at compile-time in [`config.h`](https://git.sr.ht/~mil/lisgd/tree/master/item/config.def.h) for [`lisgd`](https://git.sr.ht/~mil/lisgd), are overridden by command-line specifications in [sxmo_lisgdstart.sh](https://git.sr.ht/~mil/sxmo-utils/tree/master/item/scripts/core/sxmo_lisgdstart.sh). See the [userguide](https://git.sr.ht/~mil/sxmo-docs/tree/master/USERGUIDE.md#strongglobal-ui-controlsstrong) for a description.
The built-in responses to screen gestures that are specified at compile-time in [`config.h`](https://git.sr.ht/~mil/lisgd/tree/master/item/config.def.h) for [`lisgd`](https://git.sr.ht/~mil/lisgd), are overridden by command-line specifications in [sxmo_lisgdstart.sh](https://git.sr.ht/~mil/sxmo-utils/tree/master/item/scripts/core/sxmo_lisgdstart.sh). See the [userguide](./USERGUIDE.md#strongglobal-ui-controlsstrong) for a description.

## System Events - udev
A variety of system activities trigger udev events which are matched by rules in `/etc/udev/rules.d/` and `/usr/lib/udev/rules.d`.

M USERGUIDE.md => USERGUIDE.md +3 -3
@@ 2,7 2,7 @@

---

[Project Overview](https://sr.ht/~mil/Sxmo) | [Install Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/INSTALLGUIDE.md) | [User Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/USERGUIDE.md) | [Contributing](https://git.sr.ht/~mil/sxmo-docs/tree/master/CONTRIBUTING.md) | [System Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/SYSTEMGUIDE.md) | [Images](https://images.postmarketos.org/bpo/) | [Demo Video (1.2.0)](https://diode.zone/videos/watch/9651fd70-7668-4110-8e9a-211007b8509e) | [Presentation (1.4.1)](https://diode.zone/videos/watch/3f0948cf-47df-437e-b1ea-76fec58479c2)
[Project Overview](https://sr.ht/~mil/Sxmo) | [Install Guide](./INSTALLGUIDE.md) | [User Guide](./USERGUIDE.md) | [Contributing](./CONTRIBUTING.md) | [System Guide](./SYSTEMGUIDE.md) | [Images](https://images.postmarketos.org/bpo/) | [Demo Video (1.2.0)](https://diode.zone/videos/watch/9651fd70-7668-4110-8e9a-211007b8509e) | [Presentation (1.4.1)](https://diode.zone/videos/watch/3f0948cf-47df-437e-b1ea-76fec58479c2)

---



@@ 446,7 446,7 @@ There is also a menu entry within the [Config menu](#strongincluded-menusstrong)
to update as well which runs the same commands as above.

For details on what changed between package versions or image releases
refer to [the changelog](https://git.sr.ht/~mil/sxmo-docs/tree/master/CHANGELOG.md).
refer to [the changelog](./CHANGELOG.md).

## **User Customizable Functionality**



@@ 833,7 833,7 @@ cutomization should be simple. See sxmo-util's [scripts
directory](https://git.sr.ht/~mil/sxmo-utils/tree/master/scripts)
to get a better sense of how things are put together. You can edit
the scripts on your system for temporary fixes and please consider
[contributing](https://git.sr.ht/~mil/sxmo-docs/tree/master/CONTRIBUTING.md)
[contributing](./CONTRIBUTING.md)
your changes if you believe your modifications may be useful to other
users.


M index.md => index.md +1 -1
@@ 4,7 4,7 @@

---

[Project Overview](https://sr.ht/~mil/Sxmo) | [Install Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/INSTALLGUIDE.md) | [User Guide](https://git.sr.ht/~mil/sxmo-docs/tree/master/USERGUIDE.md) | [Contributing](https://git.sr.ht/~mil/sxmo-docs/tree/master/CONTRIBUTING.md) | [Images](https://images.postmarketos.org/bpo/) | [Demo Video (1.2.0)](https://diode.zone/videos/watch/9651fd70-7668-4110-8e9a-211007b8509e) | [Presentation (1.4.1)](https://diode.zone/videos/watch/3f0948cf-47df-437e-b1ea-76fec58479c2)
[Project Overview](https://sr.ht/~mil/Sxmo) | [Install Guide](./INSTALLGUIDE.md) | [User Guide](./USERGUIDE.md) | [Contributing](./CONTRIBUTING.md) | [Images](https://images.postmarketos.org/bpo/) | [Demo Video (1.2.0)](https://diode.zone/videos/watch/9651fd70-7668-4110-8e9a-211007b8509e) | [Presentation (1.4.1)](https://diode.zone/videos/watch/3f0948cf-47df-437e-b1ea-76fec58479c2)

---
[![builds.sr.ht status](https://builds.sr.ht/~sxmo-infra/sxmo-image-builder.svg?name=Release%20Img)](https://builds.sr.ht/~sxmo-infra/sxmo-image-builder)