search

melange-re / melange

A mixture of tooling combined to produce JavaScript from OCaml & Reason
https://melange.re
Other
844 stars 52 forks source link

Documentation for testing existing projects on Melange #106

Closed ELLIOTTCABLE closed 1 year ago

ELLIOTTCABLE commented 3 years ago

To start off, maybe the single best thing to get out there quickly, is a quick tutorial for the non-initiate to make sure their (legacy BuckleScript, or ReScript, or OCaml) project works with Melange too. Bare-bones instructions to install it and compile existing BS/RS/RE/ML projects that are built on top of various tooling stacks would go a long way towards reassuring people that Melange won't go the way ReScript did, and build some initial goodwill and help onboard folks.

Melange (named pretty well) is kinda sitting at the intersection of a lot of tools, a lot of configuration, and just … A Lot for someone who's not constantly neck-deep in the OCaml ecosystem like you or I are. A 'batteries-included' quickstart tutorial that respects the visitor's time (i.e. minimal prose, maximal instructions) would be fantastic.

Personally, I'm a huge fan of the way Babel handles this:

Screen Shot 2021-03-31 at 5 46 25 PM
anmonteiro commented 3 years ago

An example to take inspiration from (I converted Relude to work with Melange): https://github.com/reazen/relude/pull/293

Additionally, we should also document that most PPXes should be compatible, especially if they're built with ppxlib!

anmonteiro commented 1 year ago

This is not too relevant anymore, and we have melange.re now.