SDK documentation ?

[rhaamo]

I wasn't able to find docs of the internals of the "SDK".

One "easy" thing would be to use Doxygen, it's inline with code using comments, and can generate HTML documentation to view online.

It would be easier to find things like "what a base app needs", "how to draw a box", "display some text" etc.
And to know the differences between View or MessageController used in the apps (to build one).

Maybe some HelloWorldApp can be created later for the documentation purposes.

[btodoroff]

I was having similar thoughts. Would the team be open to pull requests that add doxygen comments to the repository. Would be rather make my notes in a way that others can use.

[UDXS]

This really needs to happen. It's been a while. Documentation needs to be in two parts: Doxygen, where functions and classes are individually documented, and guides/tutorials, where processes such as app development are documented. If this is done, it would vastly improve the amount and quality of apps available for Epsilon and make an online os building tool which would let you pick and choose apps to put in the distribution for your calculator (like #84) viable.

[boricj]

The only two third-party apps I'm aware of are my Hello World (https://github.com/boricj/numworks-hello-world) and my tic-tac-toe (https://github.com/boricj/numworks-tic-tac-toe). The former is possibly bit-rotten since I haven't touched it in the past 6 months, the latter's code quality and cleanness is questionable. While the idea of app modularity at compile-time makes the life of developers easier, I would not expect end users to try and use these (unless there's something along the lines of TI-Planet's project builder readily available for NumWorks).

But yes, the lack of documentation makes for quite a steep learning curve, especially if you're not familiar with C++.

[UDXS]

I've seen the Rpi app https://github.com/zardam/epsilon/tree/rpi
I will be taking a look at your apps. I just generated doxygen HTML and, even without actual docs, it helps with visualization. I will put it up on GitHub Pages.

[UDXS]

Ok, the github pages thing works now. Here is the link to the docs:

https://udxs.me/EpsilonDocs/

[Ecco]

All the doc is now versioned in this repo. Feel free to open some PR if there's anything you'd like to see documented 😄