I created Cure more as an ad-hoc DSL, rather than as a general purpose language. Currently it is in the proof of concept stage, although everyone might grab it, compile it, write and execute some code with it.
I am very open to suggestions, improvements, hints, and “this is all crap” comments.
I am extremely impressed by Cure, but no, what I am after is a single PDF file that doesn’t give me RSI clickety-clicking and contains at least getting started, installation guide, tutorial, reference, and library documentation. I do know how very difficult it is to produce good documentation content. When you have it, blasting it into a thousand fragments doesn’t make it better.
Did I mention that I am EXTREMELY IMPRESSED by Cure and yearn to understand it?
I don’t know how the Rust people do it, but their clickety-clickety RSI-fest “books” have a “print” button on the top right that prints every page, forming a coherent PDF.
Since ex_doc generates a .epub file I thought I’d just convert that to PDF and drop it here for convenience.
A couple of changes to rebar.config brought in missing referenced files (appears there are a number of .md referenced which do not yet exist in the repo)
diff --git a/rebar.config b/rebar.config
index 72a4000..678ba35 100644
--- a/rebar.config
+++ b/rebar.config
@@ -62,7 +62,17 @@
%% ExDoc configuration
{ex_doc, [
{source_url, <<"https://github.com/am-kantox/cure-lang">>},
- {extras, [<<"README.md">>]},
+ {extras, [
+ <<"README.md">>,
+ {"docs/CLI_USAGE.md", #{title => "CLI Usage"}},
+ {"docs/LANGUAGE_SPEC.md", #{title => "Complete language specification"}},
+ {"docs/TYPE_SYSTEM.md", #{title => "Dependent types and type system details"}},
+ {"docs/FSM_USAGE.md", #{title => "Finite state machine guide"}},
+ {"docs/FEATURE_REFERENCE.md", #{title => "Quick reference for all language features"}},
+ {"docs/STD_SUMMARY.md", #{title => "Standard library module documentation"}},
+ {"TODO.md", #{title => "Missing features and future work"}},
+ {"docs/EDITOR_SETUP.md", #{title => "IDE configuration for Cure development"}}
+ ]},
{main, <<"readme">>},
{output, "docs/_build"}
]}.
Since I cannot attach PDF files here, these were the steps.
Updated rebar.config
ran make docs
generated pdf via ebook-convert docs/_build/cure.epub cure.pdf
What are your plans for tracking the project features work, bugs and other issues? I see a TODO.md document but I’m not sure if it’s up to date. Long term would you start using Github Issues or something else? There are a few open issues on Github already but no response so far. Biggest one IMO is no license, I am sure many people are not even looking at the code because of that.
Everything will take a place. I am currently discussing the License with lawyers, to make sure I can grant more than MIT does.
Did not know, that people look at the code after they figured out what implications to expect. Now I am after putting an explicit statement, allowing anyone but corps.
Damn, I work for corps and wanted to consider using it. Sad to hear. Thank you for the early heads up though, would save me having to learn it and then drop it.
Very cool! Always great to see more languages on the BEAM.
Is the documentation out of date? I’ve tried to follow some of the examples (such as the ones on the homepage and in the README) but they’ve all either crashed at-boot or the commands have not existed. I would really like to try out the typing features!
