Simplify path for readers to load the SmalltalkSources?

hpi-swa-lab / SqueakByExample-english

An introductory book about the Squeak/Smalltalk programming system, guiding students and developers through the environment, language, tools, and the Morphic framework by means of a series of examples and exercises.

https://www.lulu.com/shop/patrick-rein-and-christoph-thiede/squeak-by-example-60/paperback/product-8vr2j2.html

Other

26 stars 7 forks source link

Simplify path for readers to load the SmalltalkSources? #141

Closed LinqLover closed 1 year ago

LinqLover commented 1 year ago

It's a great benefit that all methods in the book are actually available in a working package here in this repo. However, as a naive reader, I was not able to find any hint in the book on how to get these sources. Why not provide an easy way for readers to get these sources?

Possible options:

Provide a Metacello script that loads the latest SmalltalkSources from the repo (that could refer to the right branch). This could be mentioned right in the preface ("Examples and exercises") and perhaps be backreferenced from the beginning of Chapter 2 and maybe Chapter 11 as well as from the FAQ
Automatically deploy the sources to a repo on SqueakSource, and describe in the book how this repo can be accessed. Con: Especially for the first chapters, readers might feel overwhelmed by these instructions.

LinqLover commented 1 year ago

Oh, I just noticed the mention of http://www.squeaksource.com/QuintoExampleSBE.html which has a confusing ancestry and is not updated automatically. This is not good :D

LinqLover commented 1 year ago

@codeZeilen And later the book also mentions http://squeaksource.com/SqueakByExample which is out of date ... Should we keep it updated or use a fictive URL instead? If the former, for which version of the book, and manually or via CI? :-)

Later it says:

The SqueakByExample repository on SqueakSource is world readable but not world writable, so if you try and save there, you will see an error message. However, you can create your own repository on SqueakSource by using the web interface at http://www.squeaksource.com, and use this to save your work. This is especially useful as a mechanism to share your code with friends, or if you use multiple computers

codeZeilen commented 1 year ago

@LinqLover hm... at the very least we should have the up-to-date source code in a repo for the release. Maybe squeaksource.com/SqueakByExample60 ?

As this is a sporadic activity, I would be fine with doing this manually. But we should probably document that this has to be done as part of the release process.

LinqLover commented 1 year ago

What license?

CC-BY-SA is not listed there. Keep the field empty?

codeZeilen commented 1 year ago

@LinqLover yes, maybe mention license in the repo description instead