Work out how to integrate claudius-examples

[mdales]

We have a problem whereby Claudius and claudius-examples get out of step: if we make changes to the Claudius API here, then it breaks claudius-examples.

We could add the examples back here as an examples folder, similar to say how Dream has. Then we add them to the CI for this repo.

[pawaskar-shreya]

Pasting the examples here @mdales

I have come up with the below list, do tell me if we need to move any examples from one list to another or if we need to increase or decrease the number of examples per list. I've tried to keep the lists relatively short:

These are the ones I think we should add to Claudius, because they are sort of something a newcomer would love to explore. Sort of like beginner friendly:

• Day8 (Genuary Day 8: Chaotic)
• Day12 (Genuary 12/13: Lava Lamp/Wobbly Functions)
• Day18 (Genuary 18: Bauhaus)
• Day112 (Genuary 11: Anni Albers) (last)
• Dark Side Of The Moon (static, hence very easy to understand)
• Fern
• Genuary Day 19: Flocking
• Kochtoo TCC Day 7 Extra Extra

These are my personal favs:

• Day1 (Genuary Day 1: Particals) : This one is sort of just points moving in a 2D space. But the illusion that they create makes it look 3D. Totally worth adding to main repo
• Day2 (Genuary Day 2: No Palette) : This one I remember you telling that you used a really big palette of 1024 size to make it look like no palette. That was a clever hack and I think we should totally add that in.
• Day20 (Genuary 20/23: Generative Typography and 8x8) : A great example to demonstrate the use of fonts.
• Landscape : Involves some math, but worth totally the final result
• Tcc day5 (tunnel visual effect) : It creates that illusion as if we are travelling through space-time 🤩🤩
• Tcc day8 extra (universe) : Justtt Wowwww

Input features showcasing

• Paint example : Shows how creative users can get!
• Filedrop (to be kept in claudius-examples only)
• Keytest (should we add it here?)

All the other examples:

• Day5 - Vera Molnár (Gooooood)
• Day 6 - screensaver
• Day10 - polygons
• Day11 - Anni Albers (Gooooood)
• Day17 - Genuary Day 17: Islamic Patterns
• Day17filled - Genuary Day 17: Islamic Patterns (Gooooood)
• Ellipsespin
• Filled Ellipsespin
• Fonts
• Polygontest
• Shapes
• tcc3extra (not running)
• Triangles

[mdales]

Todo before we move:

• Remove empty tests
• Remove opam files
• Add minimal README to those we move

[mdales]

My instinct, now that Claudius is in opam, is not to merge these with Claudius. The categorisation effort and thought about them has been applied to the README.md in Claudius examples, so there's some structure there now. I think most people will hopefully get Claudius via opam to make things, and the examples just being examples I think will be less confusing.

[pawaskar-shreya]

So do we plan to keep the examples seperate so of now?

[mdales]

@pawaskar-shreya I think so, but I'm also happy to be argued the other way if you have a strong preference. My rational is that thanks to your work over the summer, Claudius feels more ready to use than it was when you started, where I felt if you were working on using Claudius you'd probably want to look at the code too.

In the original ticket I talk about Dream has a great example library in its code base, but I realise that there's a difference here in that people probably don't want to run all the dream examples, and for Claudius they probably do. So I think checking out claudius examples and running them is much easier when that's its open repository.

But like I say, happy for alternative views on this!

[pawaskar-shreya]

I think you have a good point here with people wanting to try out more and more examples locally. They would not want to just look at the code but also run it and see what it produces.

Cloning the repo is one way to do that, but the upside being, it keeps the api lightweight, which is a good thing in my opinion. Also, we have directed users to the examples repo in the docs, so it sort of also makes it easier for them to access the examples in that way!