From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Roman Scherer Newsgroups: gmane.emacs.devel Subject: Re: Add plz-media-type and plz-event-source to GNU ELPA when stabilized Date: Mon, 29 Apr 2024 09:44:25 +0200 Message-ID: <87edao1uli.fsf@burningswell.com> References: <87h6fnmb4b.fsf@burningswell.com> <87frv6q5t5.fsf@posteo.net> <87o79ttzma.fsf@burningswell.com> <87r0eon1i1.fsf@posteo.net> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="25713"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: mu4e 1.12.4; emacs 29.3 Cc: emacs-devel@gnu.org, ahyatt@gmail.com To: Philip Kaludercic Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Apr 29 10:25:01 2024 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1s1MJo-0006Ua-Mp for ged-emacs-devel@m.gmane-mx.org; Mon, 29 Apr 2024 10:25:00 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1s1MJC-0002w0-6b; Mon, 29 Apr 2024 04:24:22 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1s1Lgj-0000oN-SJ for emacs-devel@gnu.org; Mon, 29 Apr 2024 03:44:38 -0400 Original-Received: from mail-lf1-x131.google.com ([2a00:1450:4864:20::131]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1s1Lge-00010D-91 for emacs-devel@gnu.org; Mon, 29 Apr 2024 03:44:37 -0400 Original-Received: by mail-lf1-x131.google.com with SMTP id 2adb3069b0e04-51bae805c56so4816945e87.0 for ; Mon, 29 Apr 2024 00:44:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=burningswell-com.20230601.gappssmtp.com; s=20230601; t=1714376669; x=1714981469; darn=gnu.org; h=mime-version:message-id:date:user-agent:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=/mFtoUCoav1edf9V3eo84Y6I7gCerYNuGdTLMcRLLGY=; b=vHYT//+Qtmz9I6GF4MvaL8RZHZUNBwyFLyAWW4Y+x8DKFq9KyjL6QcA5uglfhZM8Jj LxfUCpz88/RyPj9RKCc6CXCygAkEYa8jivlIK6udkJR62jDX/ScZJ34OLwbqfZq9h3Aj 6OvxQNKugj86SPSA+amzUIDuzmRgm/PJaOFKuvic6Gu8RP3YkQmxmSpgs5Phw81iLR0t f3kYGMDoE1hSP1T/uFULqwiEhMvr8szMsAUL9iMoGbELKiw0H8vOTF87Zi46NkGX+4nu T2tMELZbAXgTX7Etp/EHJTayS7GmoG3spJbfrU8wzWKq+rB6iO4ivYg6i9TMjSIZ2RLc Bfiw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714376669; x=1714981469; h=mime-version:message-id:date:user-agent:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=/mFtoUCoav1edf9V3eo84Y6I7gCerYNuGdTLMcRLLGY=; b=Mb9b/5m1wY9dXPqFyVve0yemmu5JjEenb0htVOQH6icWz3POPZ1f9sRODC2himqB7W Ktp0Y8s9bELbs7L1Qo2gJgXPv9hpXwjc47LzcNlMlz23IQ+RyuFmkwPUbzc94AkhaDF7 pvLcIWvNvBW664YLHeLT9DdXBrZWk0qO0A7uRTGmUYNaNQof5Q8nG0DcLyNh5co8+3U5 /6ltiV6LXECbqGtRyrtu5Q96RMR17uTpnK1Kna1DcUp5oTNjiUPtxrtYXoUrC4tYowCN vE3N7rq7mPHZv1SYQeBpmkrpblBzLjredEFuoIfAmfmY1CHrpY6o6PAHjYCojvURQR99 5Ypw== X-Gm-Message-State: AOJu0Yx53awzA3D3UQ5v+detYPNbfiEErrRfNHn4pdvYZdKN/Dl4YcWI IpIzwDOhA71zPM9TExtc5PP09WqYPoIOPGMqNXi644CdB2Q2kCVWOqiaztuhFzI= X-Google-Smtp-Source: AGHT+IE0drTg7cdSgog+9mT1lVfr57D0cVL+U5Ls2RNBEu2Dvj9xlgzbMIDv3+aA3Uoivp4vmeggXg== X-Received: by 2002:ac2:5101:0:b0:51c:d13d:44c5 with SMTP id q1-20020ac25101000000b0051cd13d44c5mr5096159lfb.47.1714376668804; Mon, 29 Apr 2024 00:44:28 -0700 (PDT) Original-Received: from precision (tmo-085-109.customers.d1-online.com. [80.187.85.109]) by smtp.gmail.com with ESMTPSA id a101-20020a509eee000000b00572459a4ffesm4455817edf.56.2024.04.29.00.44.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Apr 2024 00:44:28 -0700 (PDT) In-Reply-To: <87r0eon1i1.fsf@posteo.net> (Philip Kaludercic's message of "Mon, 29 Apr 2024 06:09:42 +0000") Received-SPF: none client-ip=2a00:1450:4864:20::131; envelope-from=roman.scherer@burningswell.com; helo=mail-lf1-x131.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Mon, 29 Apr 2024 04:24:19 -0400 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:318328 Archived-At: --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Hi Philip, Philip Kaludercic writes: > > The different files have different audiences. I'd say: > > - The README is an introduction to anyone who just checked out a > repository (or found it on some Website), and wants to know what it is > about. It should just be a starting point, linking to other resources > (INSTALL, COPYING, ChangeLog, proper documentation, ...) where > possible. > > - The documentation is for people who have installed a package and want > to know the exact details of how something works or is done. It is > not something that would usually interest someone who hasn't > downloaded and installed a package. > > - The package description (C-h P foo RET) is a brief explanation of what > a package does and provides. It should focus on the questions the > user might have when they first encounter the package: > > * If the name is not indicative, what is the package even about. >=20=20=20 > * What is the core functionality and how is it used. > > * Who is the target audience. > > * What are the entry points to the package. > > * What differentiates the package from other similar packages. > > or other questions like these. It should NOT include: > > * A table of contents > > * Installation instructions of any kind (there is a install button in > the package description buffer) > > * Extensive details on how to configure the package > > * Screenshots, as these are currently not displayed > > * Changelog information > > and instead try and to keep it short and simple. It is just a sales > pitch, not a lecture. > > Sadly a number of packages just use the same README.org file for all > these things, confusing the separate audiences. If anything, it is > acceptable to mix the first two, but the third should certainly not > result in a 500+ line buffer (as is currently the case with "plz"). The > easiest way to address the last point is just to use the commentary > section in the main file to generate the description of the package, > which we can configure in elpa.git. Ok, thanks for the explanation. I will then split the README and the manual up. I will do this in the next days. I looked a bit around and will probably do something similar to what Protesilaos does in his packages. This one being an example: https://github.com/protesilaos/ef-themes Roman --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQFTBAEBCAA9FiEE0iajOdjfRIFd3gygPdpSUn0qwZkFAmYvT9ofHHJvbWFuLnNj aGVyZXJAYnVybmluZ3N3ZWxsLmNvbQAKCRA92lJSfSrBmTFZB/wNP8VhvU4t5fmh HGYwpzHcJJyzK0s+7wddTkamlPYvb9gbq+qXISITwMJIpm4TQpNFLYi+XzAPWKiK o5fx9uW9hvItvsyv30HzkuOeaX2h81um07jmQg/B47fgIz68JnHTXkd8GQkO7aVN pJRsrzA9J5xZbQ6aTAqIKYYIiQKvuVr+Y8EIlABhURskhxINCoQIvqGIxi6rH7um J5xi29t23h5OfKPqyjJF7qrK836RrPWARiBFu8v/WfPl485blgsoVW9pjO0q4okK Fe6weCB1ExjqlItezrVpQPysOpBUpXi09xE5APE7bLlwPfkGTDhWLYuD1afXTBIw bjJZKYEQ =omhK -----END PGP SIGNATURE----- --=-=-=--