From faf5cd914d7e8f1dcf766410f571ea4fbbe46453 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Sat, 13 Feb 2021 19:05:05 +0100 Subject: moved up Intallation section in README.md --- README.md | 50 +++++++++++++++++++++++++------------------------- about.html | 28 ++++++++++++++-------------- 2 files changed, 39 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index c64048a..f316497 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,31 @@ It is written to be used on [Devuan GNU+Linux](https://www.devuan.org/) but it should work on other Debian-based distributions. +Installation +============ + +1. Clone this repository locally. +2. Do `make debian`. +3. Install the generated `my-x200` `.deb` package as root with `dpkg + -i`. +4. Edit `/etc/default/my-x200`. + +Alternatively, a `.deb` file ready to be installed and its associated +`.dsc` source package file are provided in this repository. Once +these two files and the corresponding two source files `.orig.tar.gz` +and `debian.tar.xz` are downloaded in the same directory, it is +advisable to verify the signature like so:— + +1. Download the `my-x200` master tarball: +2. Import the developer's [public PGP + key](https://pgp.ocf.berkeley.edu/pks/lookup?search=0x1773e9248085c8c7), + like so: `gpg --recv-keys 8085C8C7` +3. Verify the signature: `dscverify --keyring ~/.gnupg/pubring.gpg + my-x200_.dsc` (Replace `` with the actual release + number.) + +For a good GPG cheat sheet, see [here](https://guides.library.illinois.edu/data_encryption/gpgcheatsheet). + Configuration ------------- Once installed, `my-x200` is configured by editing @@ -77,31 +102,6 @@ course, the backup process is triggered on certain conditions only: Then, once these conditions are met, the backup process is triggered whenever the service is stopped. -Installation -============ - -1. Clone this repository locally. -2. Do `make debian`. -3. Install the generated `my-x200` `.deb` package as root with `dpkg - -i`. -4. Edit `/etc/default/my-x200`. - -Alternatively, a `.deb` file ready to be installed and its associated -`.dsc` source package file are provided in this repository. Once -these two files and the corresponding two source files `.orig.tar.gz` -and `debian.tar.xz` are downloaded in the same directory, it is -advisable to verify the signature like so:— - -1. Download the `my-x200` master tarball: -2. Import the developer's [public PGP - key](https://pgp.ocf.berkeley.edu/pks/lookup?search=0x1773e9248085c8c7), - like so: `gpg --recv-keys 8085C8C7` -3. Verify the signature: `dscverify --keyring ~/.gnupg/pubring.gpg - my-x200_.dsc` (Replace `` with the actual release - number.) - -For a good GPG cheat sheet, see [here](https://guides.library.illinois.edu/data_encryption/gpgcheatsheet). - Use and recommended configuration --------------------------------- > The command `rc-update` that is used below refers to `openrc`. Other diff --git a/about.html b/about.html index e7244d5..fc09fec 100644 --- a/about.html +++ b/about.html @@ -27,6 +27,20 @@

Overview

my-x200 is a simple script primarily designed to make the distinctive whining noise of Thinkpads X200 disappear. But it can also be used on other laptops.

It is written to be used on Devuan GNU+Linux but it should work on other Debian-based distributions.

+

Installation

+
    +
  1. Clone this repository locally.
    2. +
  2. Do make debian.
    3. +
  3. Install the generated my-x200 .deb package as root with dpkg -i.
    4. +
  4. Edit /etc/default/my-x200.
    5. +
+

Alternatively, a .deb file ready to be installed and its associated .dsc source package file are provided in this repository. Once these two files and the corresponding two source files .orig.tar.gz and debian.tar.xz are downloaded in the same directory, it is advisable to verify the signature like so:—

+
    +
  1. Download the my-x200 master tarball: http://git.robertalessi.net/my-x200/snapshot/my-x200-master.tar.gz
    2. +
  2. Import the developer’s public PGP key, like so: gpg --recv-keys 8085C8C7
    3. +
  3. Verify the signature: dscverify --keyring ~/.gnupg/pubring.gpg my-x200_<ver>.dsc (Replace <ver> with the actual release number.)
    4. +
+

For a good GPG cheat sheet, see here.

Configuration

Once installed, my-x200 is configured by editing /etc/default/my-x200.

It is also possible to leave /etc/default/my-200 untouched. In this case, my-x200 can source its configuration from one or more *.conf files written in a specific directory /etc/default/my-x200.d/ which is to be created. This is the recommended method for these files cannot be affected by subsequent updates.

@@ -42,20 +56,6 @@
  • An (empty) dobackup file must be present in the backup directory.

    • Then, once these conditions are met, the backup process is triggered whenever the service is stopped.

    -

    Installation

    -
      -
    1. Clone this repository locally.
      2. -
    2. Do make debian.
      3. -
    3. Install the generated my-x200 .deb package as root with dpkg -i.
      4. -
    4. Edit /etc/default/my-x200.
      5. -
    -

    Alternatively, a .deb file ready to be installed and its associated .dsc source package file are provided in this repository. Once these two files and the corresponding two source files .orig.tar.gz and debian.tar.xz are downloaded in the same directory, it is advisable to verify the signature like so:—

    -
      -
    1. Download the my-x200 master tarball: http://git.robertalessi.net/my-x200/snapshot/my-x200-master.tar.gz
      2. -
    2. Import the developer’s public PGP key, like so: gpg --recv-keys 8085C8C7
      3. -
    3. Verify the signature: dscverify --keyring ~/.gnupg/pubring.gpg my-x200_<ver>.dsc (Replace <ver> with the actual release number.)
      4. -
    -

    For a good GPG cheat sheet, see here.

    The command rc-update that is used below refers to openrc. Other init systems use other commands. Please adapt.

    -- cgit v1.2.3