ARCHITECTURE.md: Initial revision

[schancel]

The intent of this PR is to introduce the ARCHITECTURE.md root file. This file will eventually include a high level overview of the SDC compiler and how it operates. New contributors should be able to read this file to make sense of the subsystems in the compiler, and which APIs they should be working with to obtain the information they need to process.

[deadalnix]

Maybe you want to put this into a doc folder or something and add a link in the README ?

Overall I think that this is a very nice effort. Make you don't go too much into details in part that are partially in flux, as wrong doc is worse than no doc usually. I'll be traveling over the weekend, so I won't be able to provide too much feedback before monday.

[schancel]

Thanks for the suggestion. I'll do that. I think that the current topics are where I am going to stop. I'm intending to provide what each thing does; and where a contributor can find the entry point to that subsystem; and possibly some implementation details where it's relevant (e.g. how the visitor pattern works with the scheduler, etc.)

[JohanEngelen]

Thank you very much for this documentation. I am looking at SDC again since a while and... man all those directories... A guide to the directory structure would be very nice too.

[schancel]

Thanks for the feedback! That's my plan. I need to get back at this. I had
the same problem. I did a few small patches awhile ago and every time I get
back to it I have to mentally figure out this and it takes a long time.
On Sat, Aug 13, 2016 at 11:00 AM Johan Engelen notifications@github.com
wrote:

Thank you very much for this documentation. I am looking at SDC again
since a while and... man all those directories... A guide to the directory
structure would be very nice too.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#202 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AANC7KFSxRTt3-RDnlXMbJ9hcjfEQRF0ks5qfgZTgaJpZM4JeJnr
.

[UplinkCoder]

The AST and the IR are separate.
Rather the AST is the basis for the IR.
The AST is not touched after parsing.
The IR is indeed subject to lowering and other transformations

[schancel]

If anyone is interested, I've begun working on this again.