From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Yuri Khan Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Mon, 27 Jun 2022 21:29:47 +0700 Message-ID: References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> <87h74ztshe.fsf@gmx.de> <871qw31ois.fsf@yahoo.com> <8735gj4ceo.fsf@gnu.org> <87sfojz63r.fsf@yahoo.com> <87h74z5nio.fsf@localhost> <87ilpf45mo.fsf@disroot.org> <87pmjnumzg.fsf@posteo.net> <877d5ut6z6.fsf@posteo.net> <87o7yink44.fsf@posteo.net> <87letjzppl.fsf@posteo.net> <87letjinbr.fsf@posteo.net> <87h746xw07.fsf@posteo.net> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="9159"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Stefan Monnier , Akib Azmain Turja , Ihor Radchenko , Po Lu , Tassilo Horn , Michael Albinus , Alan Mackenzie , Stefan Kangas , Emacs developers To: Philip Kaludercic Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Jun 27 16:37:18 2022 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 1o5prZ-0002A4-Ol for ged-emacs-devel@m.gmane-mx.org; Mon, 27 Jun 2022 16:37:17 +0200 Original-Received: from localhost ([::1]:56478 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1o5prY-0002F5-BM for ged-emacs-devel@m.gmane-mx.org; Mon, 27 Jun 2022 10:37:16 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56396) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1o5pkY-0003DE-RP for emacs-devel@gnu.org; Mon, 27 Jun 2022 10:30:03 -0400 Original-Received: from mail-il1-x130.google.com ([2607:f8b0:4864:20::130]:39547) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1o5pkW-0002Ta-Vy; Mon, 27 Jun 2022 10:30:02 -0400 Original-Received: by mail-il1-x130.google.com with SMTP id a16so6143934ilr.6; Mon, 27 Jun 2022 07:29:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc:content-transfer-encoding; bh=j869IU71VL0ZzbZQVxVP/en1JYS+/88gqeg6HGG6zsA=; b=Qu6p93nJQJ8KnJVp1XmLRp28v8dEEmXjX1upTTyUZLoAYkIRUYM+L2rlL4EkRt0ksj BKHKzam9VH1Qo6xMQ19532rsYrjHxyJ7hJRfx1wnWZQBmUI2OW+KDS1P16YGycCda07Q WGZGEkOcICWbe5gOZSs7HQn7GL7PmRn1OvGD28R8A8BDMs6A3LjAOuJMoSxOpxqH/ARA uyFxWY9kqT3LXnM6U757RHInTUTLZ6sYvJZUqWNac7ZmyOoJUpfZBA6lOFgMhe3IGdIr A9uRu1sw6nrXvgXCs8VtWdePD2FdxaEGWK4OM7Rm45AuNRvRBCtf9SHis9Ytl6QAduNk EwsA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=j869IU71VL0ZzbZQVxVP/en1JYS+/88gqeg6HGG6zsA=; b=7LBF94G+fREP5qt2BY87WfKjcyMKcS+HtxiHP3ytZUzs2W7FwIu9zXZGBIe/pQREri hHUklRtyLq5WTaHIN92SR20XOYdlPxRODZ42/cbWnkX90+4/DCQF6GhwH/Gd3QipK58Y R33Ggezm2ZI6f8tqYr6PTjQ0b1fE2aB03disB5P0jkkx+pyyHi9itO14Ar9L65tNcOId wwUVG8IbOYbn78HbxbZQ9O+PiT8IdbSfDqM9+Zqh32RZI13isCkecz6hhCdi8Vu/7i8q s4IYLcrvy+FuuECVhvHWlQcicU48fX0uxg/A4MzjL9FrKpoM9//ghrbYUMgL94Wbk1/D nPvA== X-Gm-Message-State: AJIora+Moeren3ga05UhF+rtMavNPkeJ8G6Hu8l5CuRDRM2jxQ5bif58 UH48yvTtNrXVpxI9ZH8z71CNqXy+l5VoOKJf0fg= X-Google-Smtp-Source: AGRyM1seTgn7me0hBMuMEmKYHIIE7LOCoOjeY5j2fSR4Bpwm0HkB28kIsybjzXb9O1DBZuUEOvPXhtc2QhPij9TgLq0= X-Received: by 2002:a05:6e02:214a:b0:2da:a56a:c1cf with SMTP id d10-20020a056e02214a00b002daa56ac1cfmr702708ilv.5.1656340198972; Mon, 27 Jun 2022 07:29:58 -0700 (PDT) In-Reply-To: <87h746xw07.fsf@posteo.net> Received-SPF: pass client-ip=2607:f8b0:4864:20::130; envelope-from=yurivkhan@gmail.com; helo=mail-il1-x130.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action 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" Xref: news.gmane.io gmane.emacs.devel:291663 Archived-At: On Mon, 27 Jun 2022 at 17:05, Philip Kaludercic wrote: > > Maybe throwing out the badges would be a good first step ;-) > > Then again, this ties into the README files that look better when > rendered on GitHub/Lab, and where it is worth considering if *not* > using them would be of more use. Badges do not have to be ugly in markdown source. Or, at least, they can be much less ugly. Let=E2=80=99s dissect [Eglot=E2=80=99s README.md][1] just as an example (on= ly because it has badges; otherwise, I think Eglot=E2=80=99s README.md is as non-ugly = as possible): [1]: https://raw.githubusercontent.com/joaotavora/eglot/master/README.md [![Build status](https://github.com/joaotavora/eglot/actions/workflows/= test.yml/badge.svg)](https://github.com/joaotavora/eglot/actions/workflows/= test.yml) [![GNU ELPA](https://elpa.gnu.org/packages/eglot.svg)](https://elpa.gnu= .org/packages/eglot.html) [![MELPA](https://melpa.org/packages/eglot-badge.svg)](https://melpa.or= g/#/eglot) Here we have three source lines, each longer than 80 characters. They are not separated with blank lines, so they comprise a single paragraph; the badges are rendered in a single line. Each badge is a hyperlink [](); brackets contain the link text and parentheses specify the link target URL. There is alternative syntax where you put a short reference identifier at the place of use, and define that reference on a separate line. [![Build status](https://github.com/joaotavora/eglot/actions/workflows/= test.yml/badge.svg)][build] [![GNU ELPA](https://elpa.gnu.org/packages/eglot.svg)][elpa] [![MELPA](https://melpa.org/packages/eglot-badge.svg)][melpa] [build]: https://github.com/joaotavora/eglot/actions/workflows/test.yml [elpa]: https://elpa.gnu.org/packages/eglot.html [melpa]: https://melpa.org/#/eglot Next, each badge=E2=80=99s text is actually an image ![](). Brackets contai= n the alt text fallback for user agents that do not display images; and parens specify the image URL. The same external reference syntax works: [![Build status][build-badge]][build] [![GNU ELPA][elpa-badge]][elpa] [![MELPA][melpa-badge]][melpa] [build]: https://github.com/joaotavora/eglot/actions/workflows/test.yml [elpa]: https://elpa.gnu.org/packages/eglot.html [melpa]: https://melpa.org/#/eglot [build-badge]: https://github.com/joaotavora/eglot/actions/workflows/test.yml/badge.svg [elpa-badge]: https://elpa.gnu.org/packages/eglot.svg [melpa-badge]: https://melpa.org/packages/eglot-badge.svg Now, only one line is longer than 80 characters. URLs specified this way can appear anywhere in the markdown source. Eglot=E2=80=99s README actually uses this syntax for all other (non-badge) hyperlinks and puts URLs at the bottom.