aboutsummaryrefslogtreecommitdiff
path: root/community/README.md
diff options
context:
space:
mode:
authorMarshall Lochbaum <mwlochbaum@gmail.com>2021-09-21 08:51:56 -0400
committerMarshall Lochbaum <mwlochbaum@gmail.com>2021-09-21 08:51:56 -0400
commit3416ff8a8f06155120382614fc18933681d4abab (patch)
tree479f3abcd7e64d6945fe88d9311388b3a69c36a4 /community/README.md
parentd1b42a082856976a3af4c31159bb43007ed5af92 (diff)
Rework front page to start with current state of BQN and move some sections to external pages
Diffstat (limited to 'community/README.md')
-rw-r--r--community/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/community/README.md b/community/README.md
index b400c739..ede4b220 100644
--- a/community/README.md
+++ b/community/README.md
@@ -18,3 +18,15 @@ And the links below point to BQN submissions on some sites that encourage shorte
And also:
- [BQN fan art](fanart.md)
+
+## Can I help out?
+
+Certainly! There are never enough hours in the day and contributors from beginner to advanced programmers are all welcome. If you're interested I recommend you ask on the forums first to get a feel for what exactly is needed.
+
+You will certainly feel an urge to skip this paragraph and get to the fun stuff, but the most important resource for implementing a language is **testing** and the most valuable one for building a language community is accessible introductions to the language and **learning materials**. These are both very demanding, but if you're willing to put in the work to advance BQN in the most effective way then this is it. One form of documentation that many users would appreciate is short descriptions—a sentence or two with examples—of the primitives for each glyph that can be displayed as help in the REPL. To be honest I'm lousy at making these and would prefer for someone else to do it.
+
+Work on BQN's **implementation** generally requires a high level of programming skill. We are focusing development effort on [CBQN](https://github.com/dzaima/CBQN) (see this [source overview](https://github.com/dzaima/CBQN/blob/master/src/README.md)). It's true that the entire compiler and a (decreasing) portion of the runtime is written in BQN, but it would be hard to do much with these as they are very nearly complete, and work satisfactorily. On the other hand, there is a lot that needs to be written in C, including [system values](spec/system.md) and higher-performance [primitives](implementation/primitive/README.md). And there's no need to work on *our* implementation! BQN's [specification](spec/README.md) and [tests](test/README.txt) are there to make sure you can write a conforming implementation, and extend it with your own ideas. It's also possible to take advantage of the self-hosted BQN sources by writing a [virtual machine](implementation/vm.md) that allows you to embed BQN in the language of your choice.
+
+Building **libraries** for BQN users can make writing programs in the language much more approachable. You are a better judge of which libraries are needed than I. Port some code from another language, implement some useful functionality in a field you specialize in, or try something new that interests you. A library should be structured as a file (which might load other files) that loads a namespace. This isn't too well-documented now, but see the [namespace documentation](doc/namespace.md) for hints.
+
+Those are possibilities, not limitations. The best way to contribute might be fixing something I never knew was wrong.