Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference/docs? #1

Open
nataliefreed opened this issue Aug 16, 2018 · 3 comments
Open

Reference/docs? #1

nataliefreed opened this issue Aug 16, 2018 · 3 comments

Comments

@nataliefreed
Copy link

Thank you for this great library!

The tutorials and examples are very helpful and clear, but I couldn't find an overall reference. I started taking some notes here:
https://docs.google.com/document/d/1kKsBw3C4jrPGtr7BRYbmcbid4FgWn0_CzdNy1bQ60b8/

Would these be useful to have in some other format once I'm done? Happy to work on this if it doesn't already exist (also possible that I missed something).

Note: I used this as a starting point to generate a doc: https://github.com/weavejester/codox

@interstar
Copy link
Owner

Hi Natalie,

thanks for your interest. And message.

I'm sorry, I only saw this now. I obviously haven't been paying enough attention to Github over the last couple of months. :-(

I have been working on some updated tutorials using devcards so you can see the code generating the patterns live in the browser. These are here : http://alchemyislands.com/bs/assets/patterning/tutorial_site/index.html#!/tutorial.core

via here : http://alchemyislands.com/patterning.html

These devcards with the tutorials were in my local development repository but I hadn't pushed them up here yet. So I just did that.

Have a look and see if that works for you.

The ideal will be to have editable code in the tutorial so you can chance and run it in the browser. But I'm having some problems with that (basically because it's hard to get library namespaces into an eval in ClojureScript)

If you are interested in adding more tutorials / examples then I'll be delighted to include them. Either as texts or in the devcard format.

regards

Phil

@interstar
Copy link
Owner

interstar commented Oct 1, 2018

Other thoughts on looking through your docs.

Many thanks again for what you've been doing here.

I haven't tried codox. But it looks useful. I'll have a play with it.

Also, I'm probably going to do a bit of a refactor / clean up ... take some of the more complex but perhaps arbitrary stuff that's in the examples / design-language / symbols-library and figure out how to organize them in a more principled way.

I can't quite decide whether Patterning should have a lot of "batteries included" in terms of extra pattens / symbols or whether that makes it cluttered and they should be elsewhere ... maybe just in an online catalogue from which they could be copied and pasted into your own projects, rather than lurking in obscure files.

Do you have any opinion on that?

cheers

@interstar
Copy link
Owner

UPDATE :

The latest tutorial site for Patterning is now made with Cardigan Bay (which includes Patterning library functionality) and can be seen here : http://alchemyislands.com/tutorials/HelloWorld.html

You can also play directly with Patterning in your browser by visiting http://alchemyislands.com/rose-engine/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants