public inbox for ~johnnyrichard/olang-devel@lists.sr.ht
 help / color / mirror / code / Atom feed
* [PATCH olang v1] docs: remove HACKING section from README file
@ 2024-09-09 13:53 Johnny Richard
  2024-09-10  3:25 ` Carlos Maniero
  0 siblings, 1 reply; 2+ messages in thread
From: Johnny Richard @ 2024-09-09 13:53 UTC (permalink / raw)
  To: ~johnnyrichard/olang-devel; +Cc: Johnny Richard

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 <johnny@johnnyrichard.com>
---
 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


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2024-09-10  3:25 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-09-09 13:53 [PATCH olang v1] docs: remove HACKING section from README file Johnny Richard
2024-09-10  3:25 ` Carlos Maniero

Code repositories for project(s) associated with this public inbox

	https://git.johnnyrichard.com/olang.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox