all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Jean Pierre De Jesus DIAZ via Guix-patches via <guix-patches@gnu.org>
To: "56960@debbugs.gnu.org" <56960@debbugs.gnu.org>
Subject: [bug#56960] [PATCH] * gnu: Add siglo.
Date: Thu, 11 Aug 2022 11:56:00 +0000	[thread overview]
Message-ID: <XstYJbX5smxZuTd-017ZvUVs-6SO8I6qfWAbVkAVrx685Q6CIWBTVlp-NVdYtrZFrxn6mtYbIT3ocRLs5r8KrByM4tEcFYr0aQXutSKaXs8=@jeandudey.tech> (raw)
In-Reply-To: <BY5PR07MB70295CC0C994E9AF0BCC5300999C9@BY5PR07MB7029.namprd07.prod.outlook.com>

Hello,

Just a quick review.

>+                    (url (string-append "https://github.com/alexr4535/" name "/"))

`name' is discouraged from being used on the source URL.

If the package name changes, the URL does too. Can't recall where I saw it if
on the documentation or IRC.

>+    (arguments
>+     `(#:glib-or-gtk? #t
>+       #:phases
>+       (modify-phases %standard-phases

You'll probably want to use a list (argument (list ...)) instead of
quasi-quoting, and also, use G-Expressions, see (guix)G-Expressions:

https://guix.gnu.org/manual/en/html_node/G_002dExpressions.html

As the method used for the package is being phased out.

For example:

(arguments
 (list #:glib-or-gtk? #t
       #:phases
       #~(modify-phases %standard-phases
            ...)))

>+             (wrap-program (string-append (assoc-ref outputs "out")
>+                                          "/bin/siglo")

After using G-Expressions, this can be simplified to:

(wrap-program (string-append #$output "/bin/siglo")
  ...)

>+  (synopsis "GTK app to sync InfiniTime watch with PinePhone")

GTK is an implementation detail, no need to be specified, and if necessary,
better suited for the description.

See (guix)Synopses and Descriptions:

https://guix.gnu.org/manual/en/html_node/Synopses-and-Descriptions.html

For example, variations could include:

* "Application to synchronize InfiniTime with PinePhone"
* "Synchronize InifniTime with PinePhone"
* "Smartwatch synchronization application"
* etc.

Keep in mind that synopsis != description. Probably someone with more experience
than me could correct me on this topic.

>+  (description "@code{siglo} is a graphical tool to flash InfiniTime firmware to
>+watches running the InfiniTime operating system, via bluetooth.

flash -> update (non-technical term).
watches -> PineTime watches (or PineTime smartwatches).
bluetooth > Bluetooth.

>+Users can also sync the time of their watch to the time of the device running
>+@code{siglo} as well as check the battery charge of their watch or what version
>+of firmware their watch is running.

sync -> synchronize.

Maybe @itemize or @enumerate could be used to list the features provided, like so:

Siglo (or @code{siglo}) provides the following features:

@itemize
@item Retrieve the version of the InfiniTime firmware running.
@item Check the battery charge.
@item Synchronize the time.
@end itemize

>--- a/gnu/packages/flashing-tools.scm
>+++ b/gnu/packages/flashing-tools.scm

Not entirely sure if this belongs in this category. Or if there's another applicable.

—
Jean-Pierre De Jesus DIAZ




  reply	other threads:[~2022-08-11 11:57 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-03 20:23 [bug#56960] [PATCH] * gnu: Add siglo Wamm K. D
2022-08-11 11:56 ` Jean Pierre De Jesus DIAZ via Guix-patches via [this message]
2022-08-31 20:44   ` Ludovic Courtès
2022-09-04 22:27     ` Wamm K. D.
2022-08-11 19:00 ` Maxime Devos
2022-09-26 18:33   ` Wamm K. D.
2023-03-12  2:02     ` Jaft
2023-03-16 10:19       ` Ludovic Courtès
2023-03-17 16:03         ` Jaft
     [not found]         ` <887796113.1601186.1679068986036@mail.yahoo.com>
2023-05-16 17:19           ` Jaft

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='XstYJbX5smxZuTd-017ZvUVs-6SO8I6qfWAbVkAVrx685Q6CIWBTVlp-NVdYtrZFrxn6mtYbIT3ocRLs5r8KrByM4tEcFYr0aQXutSKaXs8=@jeandudey.tech' \
    --to=guix-patches@gnu.org \
    --cc=56960@debbugs.gnu.org \
    --cc=me@jeandudey.tech \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.