diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..20fed83 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,18 @@ +# introduction +The source code of the IFM is a bit different from other projects you might know. Historically I developed it literally in one single file. As this became very confusing, I splitted the parts up into the `src` directory and searched for a nice way to compile it into a single file in the end. Other single-file script solutions, like [Adminer](https://github.com/vrana/adminer), use custom compilers for their scripts, so I decided to do it in a similar way. + +## compiler +The compiler script is written in PHP and does essentialy three things: +* replace the includes with actual file content +* concat PHP files while removing the first line (`