som-st / black-diamonds Goto Github PK

Document how to:

• use BD in an existing Truffle language
• how to develop BD, use CI, etc

As noticed by @daumayr, when compiling SOMns on Java 9, we use the --release 8 flag.

BD is however compiled as Java 9.

We should make sure that SOMns either instructs BD to use 8, or it is able to detect it somehow.

Should be addressed before
smarr/SOMns#236

One of the big questions, where I don't have yet a favorite answer is: how to structure the repositories, and dependencies on Truffle.

The two options I see are:

1. Have BlackDiamonds depend directly on Truffle, and make languages depend on the Truffle of BlackDiamonds, too.

2. Have BlackDiamonds only weekly depend on Truffle by configuring it so it finds an existing Truffle, and enables languages to update Truffle freely.

Both options have issues, because we likely won't have tested BlackDiamonds with an arbitrary Truffle version. So, updating Truffle independently can lead to issues.
On the other hand, when we bind BlackDiamonds to a Truffle version, we always need to update BlackDiamonds, and the reverse, update the language every time we update BlackDiamonds and it includes an update Truffle.

So, we got either the option of:

1. language
   -> black-diamonds -> truffle

2. language
   -> truffle
   -> black-diamonds

Any preferences, remarks, suggestions?
@Richard-Roberts @charig