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:48:54 +0200 Message-ID: <87a5lc1ue1.fsf@burningswell.com> References: <87h6fnmb4b.fsf@burningswell.com> <87frv6q5t5.fsf@posteo.net> <87o79ttzma.fsf@burningswell.com> <87r0eon1i1.fsf@posteo.net> <87edao1uli.fsf@burningswell.com> <87cyq8mx1h.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="23967"; 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:24:39 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 1s1MJS-00061P-DQ for ged-emacs-devel@m.gmane-mx.org; Mon, 29 Apr 2024 10:24:38 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1s1MJA-0002vg-MZ; Mon, 29 Apr 2024 04:24:20 -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 1s1Ll3-0003A4-JM for emacs-devel@gnu.org; Mon, 29 Apr 2024 03:49:05 -0400 Original-Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1s1Lky-0001zI-3D for emacs-devel@gnu.org; Mon, 29 Apr 2024 03:49:05 -0400 Original-Received: by mail-wr1-x42b.google.com with SMTP id ffacd0b85a97d-34d16d204f4so395037f8f.0 for ; Mon, 29 Apr 2024 00:48:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=burningswell-com.20230601.gappssmtp.com; s=20230601; t=1714376938; x=1714981738; 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=y+X0NqEwqjCk8Fauec4/aueJQ0OYQSE/Tzzq8StUgJA=; b=wxx3Q1+UAb7ajRkC5q9JatANS/OQiSDJDJDfXkTX5eOc3yZo87+Vjr6uZk3Nje2R/C 7AQdT0oFWrH24mLYwJdDlv+0oTOI1l0BG03u15an78VFeRTnF+olJH3SrBvA6Dc+vwHd tNXL4G1l+83ZPqq9QLRnIcuircxAyzDsNGZn4qSLE9TxQBNpRHWkwMJT2a9aEXna8o2b +c9+C52R+ejSp4mKqOlk203zZ3tHaY//awnxLsCV0jLE+WK2A52LoNLBg9ALNJLNWGoC 3rs1ry73xE7GuSki2xmvFJw7ZiV9fx2mAh6P+1XbTDtEOyCnMiURI9hRoVgKCG3hCSzH nUGw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714376938; x=1714981738; 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=y+X0NqEwqjCk8Fauec4/aueJQ0OYQSE/Tzzq8StUgJA=; b=fBIwbDTpZOnhJMjxTgGNlXj9ILF3OjzLmLpaPPWZ44CnNuBdV7P6qcD6fz52+3bNpj 4GR5sWNwkEx4200rcjBAHbGLONipntTFjcABOxvA/Q3N4E8aB1bCnLB1q8BN3NB/zHZS S+HvZEQzcRDP2LQVnGlRGy0afQfEihUxYR+JVy/XxfFuk7YZlOP63HObH/WK2pAXbSGk tVajfFM+CM2YCP7C8nw40f7aSFWQ/sW+lnn9OHZuMyePOTlhVyrUawoSVJnCAH54D5D+ 2ThwOxvqxZVy28Uq2hRoXKi8jj0jlNi/TphXeFnYcDSB4MvWYctwGg3najnWKoTp4Isu FNEg== X-Gm-Message-State: AOJu0YxE2tW+oVCwNhIbAMj7yS23CPOgem2Mis/pAi+/hGXfHbpDJrOb qWYKgZxzGojZyvo2iW76jBrnr5YufNGCIFrqcCXONJTEn4BaPlSo5CaefuOnSBG1cAN8tzCW+1G o X-Google-Smtp-Source: AGHT+IFSjkV/8feYYufE6tUGHdEBUceJoe5ggF078kTPMgk9Uyobz8GZ//fJGDkIz36H+5UBR94uwA== X-Received: by 2002:adf:9b86:0:b0:343:ba6c:16e9 with SMTP id d6-20020adf9b86000000b00343ba6c16e9mr6679442wrc.9.1714376937380; Mon, 29 Apr 2024 00:48:57 -0700 (PDT) Original-Received: from precision (tmo-085-109.customers.d1-online.com. [80.187.85.109]) by smtp.gmail.com with ESMTPSA id t15-20020adfa2cf000000b0034c5be9fb6dsm7861244wra.65.2024.04.29.00.48.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Apr 2024 00:48:57 -0700 (PDT) In-Reply-To: <87cyq8mx1h.fsf@posteo.net> (Philip Kaludercic's message of "Mon, 29 Apr 2024 07:46:02 +0000") Received-SPF: none client-ip=2a00:1450:4864:20::42b; envelope-from=roman.scherer@burningswell.com; helo=mail-wr1-x42b.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:318327 Archived-At: --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Hi Philip, ok, perfect. Thanks for your help on this! Roman Philip Kaludercic writes: > Roman Scherer writes: > >> 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. > > OK, I can add the packages to elpa.git in the meantime. > >> 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 > > If I am not mixing something up, I think I recommended something along > the lines I wrote above to him as well ^^ > >> Roman >> --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQFTBAEBCAA9FiEE0iajOdjfRIFd3gygPdpSUn0qwZkFAmYvUOYfHHJvbWFuLnNj aGVyZXJAYnVybmluZ3N3ZWxsLmNvbQAKCRA92lJSfSrBmWEzCACaURz3pLarEhZ9 RDo8R5lCoFGoplOHkTSu1BvqPT2sQZvt703tBbZW+OX7kbufpVPuS13qg8SNg7wO nzhtgLiHkHJkBOSQ8r7XfaN9rKokqyZRZZ98sft+Nu9vHMsP2NuqPs1ik4hZVXEM 9praUfT2ECsZS2TJJ6yL2GUX96ZkapD+e3E2pg6A9pXSXVinNYKPMtkd6UNLoM4b xXr68HAmlsDgR0pOCAQTs9oerA7Xie3Jh1rkVX5idDy03yuEAwMyMSEHA5WZxsno 7hr79ebJrqFbgTvTyweumy8HJN3ouHo0eO8eh2aFxiuGtglODXO0FHWc0HbWLtHQ uWMf5mRN =79c5 -----END PGP SIGNATURE----- --=-=-=--