From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-3.4 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED, T_SCC_BODY_TEXT_LINE,UNPARSEABLE_RELAY autolearn=ham autolearn_force=no version=3.4.4 Received: (qmail 28761 invoked from network); 19 May 2022 08:55:53 -0000 Received: from zero.zsh.org (2a02:898:31:0:48:4558:7a:7368) by inbox.vuxu.org with ESMTPUTF8; 19 May 2022 08:55:53 -0000 ARC-Seal: i=1; cv=none; a=rsa-sha256; d=zsh.org; s=rsa-20210803; t=1652950554; b=JbqFwPX5tS/rA7poWbuAo51WT8YmMJXO0LgUD8rx22Jyws74nYZ2xVQT4/IDNWum/uFznQezgW a4EsRsRwCGn13VYXlnrH6N/353Sid3ITz6MPzMnyNh0cI16EEXRXp/t7Dvkm3KATa0CVjg6cvd dIOmGB/pRbCv5/of1/g3UorGJ+u6fx+tdyx1dQmDy5hrwj4YmUMz4OZtrx6Z5EyDH/R2cPShzu 9LNR8HGg9b9QO7+NIbVsepUpy8rA/5dBtxVgcC4piBqKYO3Au9R2zJR/K1j1aBshQCaf7lk08X VT7B+Amu3dhzREi3AhOlPAjFiEhlrC2JiJLLEFolXVDZOA==; ARC-Authentication-Results: i=1; zsh.org; iprev=pass (smtpq1.tb.ukmail.iss.as9143.net) smtp.remote-ip=212.54.57.96; dkim=pass header.d=ntlworld.com header.s=meg.feb2017 header.a=rsa-sha256; dmarc=pass header.from=ntlworld.com; arc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed; d=zsh.org; s=rsa-20210803; t=1652950554; bh=XbY/JGT2FbpFQqxi7AG/+Fn1VZg/hauA29d2tId1/MM=; h=List-Archive:List-Owner:List-Post:List-Unsubscribe:List-Subscribe:List-Help: List-Id:Sender:Content-Transfer-Encoding:Content-Type:MIME-Version:Subject: References:In-Reply-To:Message-ID:To:From:Date:DKIM-Signature: DKIM-Signature; b=PlaMHRi/JeLui5amo5CR36l513JfRcKlKHMIPhtmfjss9sELAQ7/Ovab0uPt82w/UM0u4FcchC k3gz2742KXSEcuhxpvuhJ+OXErl4N4lF86WXooVJsvTGaiEK26cksMAPG94ofuK0+nN4roxGp5 l+GAMyxNInhp62/Gaym4OEbZadfG97JonXnu1WMlVBSlUTRQ7fs5sRmNKV1SbPx7LvmnELkdol CSSml7ytbJB+flzdUsARyOV6h0y4+pOqrfjbbUK5CIkTZR/NLicPk5+a+jRlWNonuyGOig9PMO xnHdWPWc7l3/gLJ7IQCQOpT0a+I9v6O08fExXoNyP3dXWw==; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=zsh.org; s=rsa-20210803; h=List-Archive:List-Owner:List-Post:List-Unsubscribe: List-Subscribe:List-Help:List-Id:Sender:Content-Transfer-Encoding: Content-Type:MIME-Version:Subject:References:In-Reply-To:Message-ID:To:From: Date:Reply-To:Cc:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID; bh=puHbktJrxNjj+6e/+n6yWN0JLEXxATdGf+YpWG/syXE=; b=KXkMOs4vJEtK2rqYPNLkRO3gxO sQ3WzGhC2FBtuKVRkW4yT8SSKBv5mCUfDTMFN0eptjUxgjnz9TbFuV2BWu4/3G3cOEqISsowVi843 aFiBU7OToXHQCjRKBNwHd+eZBJMmHiDikB0zWhcXTXCaqRgEFMTM4xi1JOAkWTyp7sJInw7spZjvX 232ZWpoB5vp2KsfR1ZkdWvWR4SPdlv2hX+8eztyPzuDPGCXaND2CVnwYv112p8Ln/LoCQag/n/aHw XtpK4ItatQhNTGGssXBnQFBEZRUnHb7kov+ng/k1mspSa4AI4IKqGmW1zj4bvukqFD/IDDIBAF2CL /sDH/w6A==; Received: from authenticated user by zero.zsh.org with local id 1nrbwl-000MyT-4T; Thu, 19 May 2022 08:55:51 +0000 Authentication-Results: zsh.org; iprev=pass (smtpq1.tb.ukmail.iss.as9143.net) smtp.remote-ip=212.54.57.96; dkim=pass header.d=ntlworld.com header.s=meg.feb2017 header.a=rsa-sha256; dmarc=pass header.from=ntlworld.com; arc=none Received: from smtpq1.tb.ukmail.iss.as9143.net ([212.54.57.96]:56768) by zero.zsh.org with esmtps (TLS1.2:ECDHE-RSA-AES256-GCM-SHA384:256) id 1nrbwF-000MdF-5N; Thu, 19 May 2022 08:55:19 +0000 Received: from [212.54.57.81] (helo=smtp2.tb.ukmail.iss.as9143.net) by smtpq1.tb.ukmail.iss.as9143.net with esmtp (Exim 4.90_1) (envelope-from ) id 1nrbwE-0004bL-Sp for zsh-workers@zsh.org; Thu, 19 May 2022 10:55:18 +0200 Received: from oxbe13.tb.ukmail.iss.as9143.net ([172.25.160.144]) by smtp2.tb.ukmail.iss.as9143.net with ESMTP id rbwEnDTSbv24mrbwEnOBcv; Thu, 19 May 2022 10:55:18 +0200 X-Env-Mailfrom: p.w.stephenson@ntlworld.com X-Env-Rcptto: zsh-workers@zsh.org X-SourceIP: 172.25.160.144 X-CNFS-Analysis: v=2.4 cv=LKR1/ba9 c=1 sm=1 tr=0 ts=628605f6 cx=a_exe a=wuFMYA7voKp1dZz7Z+vj5Q==:117 a=wbvTLvLwOfMA:10 a=IkcTkHD0fZMA:10 a=7H6ixmLU1AQA:10 a=6JLj5b4FkRSXuXNsTlIA:9 a=QEXdDO2ut3YA:10 X-Authenticated-Sender: p.w.stephenson@ntlworld.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ntlworld.com; s=meg.feb2017; t=1652950518; bh=XbY/JGT2FbpFQqxi7AG/+Fn1VZg/hauA29d2tId1/MM=; h=Date:From:To:In-Reply-To:References:Subject; b=V1/E0n6mspWY/2FPMmwAh6fLChbmSUVV5Y1LVcAcOAZTJLDz9WI1bYRQc7OfY9zYm AsAoR65vwOtLy31X0G0Bc+mt9wzCWUUy1g67VjKhcARcvqV2h2t3C2w7eu6JO8aZlD N6P1Wlg5T/jU7qyYFYfSVjATIkJeXsdblNQh3b1iSaA47bYliJ6W6xYdXVTMhI0OTK +bOD7xiX8XVV/z1aphwPcOs3yqptUCnf8k0py/TmMw6PhVmMxQaPP/qzQWbA4ZHNQV TrDGa6fDz/eq8+aZo75W8am8psg9OG0MUc9VBf1b/U6o5atifPthLpo+VM44ehn0sp DzFw4lwhvB/sg== Date: Thu, 19 May 2022 09:55:18 +0100 (BST) From: Peter Stephenson To: Bevan Stanely , zsh-workers@zsh.org Message-ID: <1540829696.208973.1652950518801@mail2.virginmedia.com> In-Reply-To: References: <33e425a1-36a6-4fa6-8a59-a892a7861d93@www.fastmail.com> Subject: Re: Proposal: Use Markdown syntax for README and other documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Priority: 3 Importance: Medium X-Mailer: Open-Xchange Mailer v7.8.4-Rev72 X-Originating-IP: 147.161.167.85 X-Originating-Client: open-xchange-appsuite X-CMAE-Envelope: MS4xfFihnE7sPtQAuLyS5Wk9eapnsOHqnW07/cACSVsCRFfg5MEFMsAr2v6QwF18C7e48oC9hAe4sZjSEN0/boQvtR11oJkkU2srIsqi/k7FBQeDm4nIMMWq kRkyA5tyeMWY8k9U0VaCzN3DGoRe7oslC1e17h2Gxv5SV4bJ8q6OrP3AwdaKLlyYA5d5Yvz8qRJBeL57WGgb9PppqhBL/Dp0HudiGlmOZdYGaTGYrkim+we0 1SK3QkFePyAfnqeQjFw5QcYbB0xo1Lawbhf75mOSjV8= X-Seq: 50251 Archived-At: X-Loop: zsh-workers@zsh.org Errors-To: zsh-workers-owner@zsh.org Precedence: list Precedence: bulk Sender: zsh-workers-request@zsh.org X-no-archive: yes List-Id: List-Help: List-Subscribe: List-Unsubscribe: List-Post: List-Owner: List-Archive: Markdown's fine for what it's does --- the only requirement I'd suggest before we start using it is that there is a firm plan to do something with it, e.g. integrate it into a website. I've been a bit bemused before staring at carefully formatted package documentation and wondering how I'm supposed to render it and having done a bit of research tentatively concluded I'm probably not supposed to and then wondered what's the point and why I had to go through this exercise in the first place... If there *is* a point, that's another matter. Pruning down README sounds sensible, too, though that probably needs a separate thread. pws