From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id KCuLNcLh3mbvzQAAe85BDQ:P1 (envelope-from ) for ; Mon, 09 Sep 2024 13:53:39 +0200 Received: from aspmx1.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id KCuLNcLh3mbvzQAAe85BDQ (envelope-from ) for ; Mon, 09 Sep 2024 13:53:38 +0200 X-Envelope-To: patches@johnnyrichard.com Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=lists.sr.ht header.s=20240113 header.b=XbL66ebn; dkim=pass header.d=johnnyrichard.com header.s=key1 header.b=LWXobHjq; spf=pass (aspmx1.migadu.com: domain of lists@sr.ht designates 46.23.81.152 as permitted sender) smtp.mailfrom=lists@sr.ht; dmarc=pass (policy=quarantine) header.from=johnnyrichard.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=johnnyrichard.com; s=key1; t=1725882818; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding:list-id: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=OURup5MjIoCJ2awu298hKhtnQJfMYidB0u8IyD5H5zE=; b=A7jj4/jM3zMQ29DM26xI31gkMhZlX/KSkSblZDcEXkx7DTO/eDJym9hcbXDwloRfaDdYlQ Q5tz5GOkJCn+EJ7ARE2wb1Nd9+nGM1bPO7kV1fkTmWflPw8KTePOFyujxo9GLy5Au1X5n9 6FJFFzg933bDBFttfE/9Sm4Ik8z9WxVkA+1ZZiPtD2M9jBHSUboiK+uu4Tj9z/pv1dz4tK xkMT+EvTcMfxi3fz7yMCNaJ3irj06jfc3xRX7eQ9PkZ2qdXSiKn4cA2iIOaqmG48dCKS8v rFDB1rE49InFwhXI82gY4fbTnNcMdBuaaUns6nIl9IPxOq0LZCTi3XvsBQiujA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=lists.sr.ht header.s=20240113 header.b=XbL66ebn; dkim=pass header.d=johnnyrichard.com header.s=key1 header.b=LWXobHjq; spf=pass (aspmx1.migadu.com: domain of lists@sr.ht designates 46.23.81.152 as permitted sender) smtp.mailfrom=lists@sr.ht; dmarc=pass (policy=quarantine) header.from=johnnyrichard.com ARC-Seal: i=1; s=key1; d=johnnyrichard.com; t=1725882818; a=rsa-sha256; cv=none; b=dUtqgvBEOBfCq/DzI/cDJyDHWFIUSci982lav0YsjYBR98yVGOV1XjqjTBWK2dsilsb3fz KGug6ValDSRfy33/ftGM+yPrBxM/MBr/OSIocGq4KAKLD3PXz3m0Abf4II3pMQjGcQy/8v Qlk/fzdiXw2toUOK9I1lsDw6DtXaOKax4BaZepR6jezxOLlndY2VUKbeFoOx22xPlpy/7t 6oNDiZ0Ck8i8Yn+Ey3zPyNgNtLgKE/QgF5EMi+oQOLsq/ZDR/5SO6WhdNLAQV5z0Rgl/Sb CcrmMEg15sOzHPyfDtK8Rn5Qjg48lIMqrFDDTmhlTKbbk3HNNYE3tzNVZeWO4A== Received: from mail-a.sr.ht (mail-a.sr.ht [46.23.81.152]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 5D14015AE5 for ; Mon, 09 Sep 2024 13:53:35 +0200 (CEST) DKIM-Signature: a=rsa-sha256; bh=givu3E8Zvc7T5unSOd9Qh5t9hUVbembVWUXZnVY1lBQ=; c=simple/simple; d=lists.sr.ht; h=From:To:Cc:Subject:Date:List-Unsubscribe:List-Subscribe:List-Archive:List-Post:List-ID; q=dns/txt; s=20240113; t=1725882814; v=1; b=XbL66ebneXF7O7rRzB7LjqXew0KNHae0nji3+PLGzo3AabAUlUYK3W0xN/bW8lqnpaImR5OV bea2jReF/PDeItJPriDDtWdB2p56Csh7AAU+UrqnxhbrMsG5hgqcQSQ8SteT0N5+5Bb+k8Rixzr mkyiEFx1UnC81O9EUEO5IMJsdLLYqJS2ghwJwkxJDIjJAH3cXZB2I7XHpV4o1zDqtnwvmMwpYQK V0jkfLnFodPhyCgZCmDN7l7YFc8gvQpATT7v3UKgfwKxIdSbcLwgNZI7lxy4ufd1XqrG68Elj5R pplFLSPHsLTku4aTv2K/za1CMO4HnmDEgwc95zsjEdcgg== Received: from lists.sr.ht (unknown [46.23.81.154]) by mail-a.sr.ht (Postfix) with ESMTPSA id 6489E2020D for ; Mon, 09 Sep 2024 11:53:34 +0000 (UTC) Received: from out-174.mta1.migadu.com (out-174.mta1.migadu.com [95.215.58.174]) by mail-a.sr.ht (Postfix) with ESMTPS id 98E91201F3 for <~johnnyrichard/olang-devel@lists.sr.ht>; Mon, 09 Sep 2024 11:53:33 +0000 (UTC) X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=johnnyrichard.com; s=key1; t=1725882812; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=OURup5MjIoCJ2awu298hKhtnQJfMYidB0u8IyD5H5zE=; b=LWXobHjqdFLnc4B8IdJk3n/7B6f32rmhU2wKNVkX+eQrvMd8nscM6/lYQsmgr6Nkgtk6G3 Uez1tA7bD8dNHoHa3iwQ+fR2FxX7vfNng8Ifddbe/gWUKOmGOJFmMrm/7ceucpBy1rZxK7 NW79ZWP3k/ZIJ3ebi0gKxNFxMcPwS5qejAcBcEgCKBKghaw432VzW1i93jPMbR5VWacquV t9JacIBJYiKmxnPTndNXWDJhFzd3i0wtoyOig5s30BJL0Bbx/btffSGbNfI3zNrL2Ufu6m Qo4RusXLpxc8IAJTpxr8FXVGkiPfzwNmicQiZYgSSg6IX/gNXSj7mSoe1VCmag== From: Johnny Richard To: ~johnnyrichard/olang-devel@lists.sr.ht Cc: Johnny Richard Subject: [PATCH olang v1] docs: remove HACKING section from README file Date: Mon, 9 Sep 2024 15:53:07 +0200 Message-ID: <20240909135320.13021-1-johnny@johnnyrichard.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Sourcehut-Patchset-Status: PROPOSED List-Unsubscribe: List-Subscribe: List-Archive: Archived-At: List-Post: List-ID: ~johnnyrichard/olang-devel <~johnnyrichard/olang-devel.lists.sr.ht> Sender: ~johnnyrichard/olang-devel <~johnnyrichard/olang-devel@lists.sr.ht> X-Migadu-Country: NL X-Migadu-Flow: FLOW_IN X-Migadu-Queue-Id: 5D14015AE5 X-Migadu-Scanner: mx13.migadu.com X-Migadu-Spam-Score: -5.89 X-Spam-Score: -5.89 X-TUID: dYTkTWCWcWr3 The README file is referencing an absent document (HACKING). Since we have the full documentation hosted at olang's website and there you can find "how to build and contribute to the compiler", we can remove the contribute section from the README and link the documentation. The documentation can be found at https://o-lang.org and locally for offline users. Perhaps in a future change, we can reference the `info` document on README file to help terminal users to read manual easily. Signed-off-by: Johnny Richard --- README | 38 +++++++++----------------------------- 1 file changed, 9 insertions(+), 29 deletions(-) diff --git a/README b/README index d8ecde9..a451fe6 100644 --- a/README +++ b/README @@ -1,33 +1,13 @@ -olang -===== +O programming language +====================== -The olang compiler. +This project contains the compiler's source code. -This project is licensed under GPLv3, read more on COPYRIGHT doc. +For instructions on how to build and run the compiler, please read +the manual on https://o-lang.org. -For instructions on how to build and run the compiler, read the HACKING -document. Please don't use this project in production, it's still under -development. +In order to build the documentation locally, use `make docs`. Once the build +process is complete, you can find the generated documentation in the +`docs/build` directory. -CONTRIBUTING ------------- - -### CODE AND DISCUSSION - -This project uses mailing lists as main medium of communication. All mail -archives can be found at https://sr.ht/~johnnyrichard/olang/lists. - -If you want to contribute to the source code, send plain text patch to: - - ~johnnyrichard/olang-devel@lists.sr.ht - -Please use git-sendmail to send the patches. You might want to configure your -git to prevent silly mistakes: - - $ git config sendemail.to "~johnnyrichard/olang-devel@lists.sr.ht" - $ git config format.subjectPrefix "PATCH olang" - -### IRC - -If you want to keep in contact with the community, feel free to join our -channel #olang on LiberaChat IRC. +NOTICE: The source code is licensed under GPLv3, read more on COPYRIGHT. base-commit: 705f54e830e50d0c069cf1e2c76bda4204bd9dcc -- 2.46.0