Skip to content
This repository has been archived by the owner on Nov 24, 2024. It is now read-only.

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SaptakBhoumik authored Dec 25, 2021
1 parent 43a6a86 commit 0ab917d
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ Thank you for taking an interest in Peregrine.

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 Peregrine is written primarily in V
The Peregrine is written primarily in C++

https://github.com/peregrine-lang/Peregrine/tree/main/Peregrine/tokenizer
https://github.com/peregrine-lang/Peregrine/tree/main/Peregrine/lexer

This folder contains the tokenizer

Expand All @@ -16,24 +16,11 @@ This is the parser and it generates the abstract syntax tree

https://github.com/peregrine-lang/Peregrine/tree/main/Peregrine/codegen

This folder contains the file that converts the abstract syntax tree to C code

https://github.com/peregrine-lang/Peregrine/blob/main/Peregrine/builtin.pe

https://github.com/peregrine-lang/Peregrine/blob/main/Peregrine/builtin.h
This folder contains the file that converts the abstract syntax tree to C++ or js code

Builtin function written in Peregrine and C

https://github.com/peregrine-lang/Peregrine/blob/main/Peregrine/Peregrine.v
https://github.com/peregrine-lang/Peregrine/blob/main/Peregrine/main.cpp

This is the entry point of the program

https://github.com/peregrine-lang/Peregrine/blob/main/Peregrine/test_runner.py

We use this file to run the test

https://github.com/peregrine-lang/Peregrine/tree/main/Peregrine/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

0 comments on commit 0ab917d

Please sign in to comment.