Create CONTRIBUTING.md

dgfug · Oct 5, 2021 · e253714 · e253714
1 parent 2cb3050
commit e253714
Showing 1 changed file with 39 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,39 @@
+Thank you for taking an interest in swallow. 
+
+Since it is a free software, you can contribute to make it better. New contributors are always welcome, whether you write code, create resources, report bugs, or suggest features.
+
+The swallow is written primarily in V
+
+https://github.com/Swallow-lang/swallow/tree/main/swallow/tokenizer
+
+This folder contains the tokenizer
+
+The tokenizer breaks the source code into smaller parts
+
+https://github.com/Swallow-lang/swallow/tree/main/swallow/parser
+
+This is the parser and it generates the abstract syntax tree
+
+https://github.com/Swallow-lang/swallow/tree/main/swallow/codegen
+
+This folder contains the file that converts the abstract syntax tree to C code 
+
+https://github.com/Swallow-lang/swallow/blob/main/swallow/builtin.sw
+
+https://github.com/Swallow-lang/swallow/blob/main/swallow/builtin.h
+
+Builtin function written in swallow and C
+
+https://github.com/Swallow-lang/swallow/blob/main/swallow/swallow.v
+
+This is the entry point of the program
+
+https://github.com/Swallow-lang/swallow/blob/main/swallow/test_runner.py
+
+We use this file to run the test
+
+https://github.com/Swallow-lang/swallow/tree/main/swallow/tests
+
+Some test files
+
+This is the file structure. Before contributing run the test_runner.py file to make sure that everything is working. If not create an issue