Skip to content

Setup Guide

Yannik Dittmar edited this page Aug 5, 2022 · 17 revisions

System requirements

We officialy support only Squeak-5.1 and newer versions of Squeak.

Installation Instructions

We recommend to drag and drop the .sar-File into your image and then click "install sar file".

~ or ~

If you don't want to wait for the next release:

  1. Make sure you have metacello-work installed.
  2. Load the project by running the following in your workspace:
Metacello new
    baseline: 'Algernon';
    repository: 'github://HPI-SWA-Teaching/Algernon-Launcher:master/packages';
    onConflict: [:ex | ex allow];
    get;
    load

If you have a version older than July 2020 you need to run the following code instead:

BaselineOfAlgernon compile: 'projectClass ^ Smalltalk at: #MetacelloCypressBaselineProject ifAbsent: [super projectClass]'.
[ Metacello new
    baseline: 'Algernon';
    repository: 'github://HPI-SWA-Teaching/Algernon-Launcher:master/packages';
    onConflictUseIncoming;   
	get;
    load. ] on: MetacelloSkipDirtyPackageLoad do: [:ex | ex resume: false. ].

~ or ~

Use the Squit-Browser to clone and load this repo directly into Squeak.

Activate Algernon (optional, if not installed using sar)

  1. Activate the panel in the preferences:
Tools > Preferences > Algernon

or execute

Algernon activateAlgernon: true
  1. Now you can toggle the Algernon panel using:

Windows and Linux: Alt+Space

Mac: Cmd+Shift+Space

  1. (optional) You can customize the keyboard shortcut :
Tools > Preferences > Algernon

Previous versions

Here you can find older versions of Algernon.

Setup Google Web Search

To enable the power of searching the whole WWW with Algernon follow the next steps. We decided to use the Google Custom Search JSON API because it offeres 100 request a day for its free tier users. We might add other search engine provider in the future.

  1. Create a Google Account if you don't already have one. Link
  2. Obtain an API key. Visit this website and click on the button that says "Get A Key". When you are logged into your Google account, you will be prompted to either create a new project or select an existing project. We recommend that you simply create a new project and name it Algernon, for example (but the name is not important). Click on "Next" and then "Show key". Finally your key is displayed. It should look something like this AIzaSyBdJ88HN7LTGkHHK5whfaVv8a5ozlx2Eg4.
  3. Create a new Programmable Search Engine and obtain the search engine id. (At the time of writing this tutorial, the new Google Control Panel is just a preview. When you land on the old panel, just click the "Show Preview" button.) Open your Google Control Panel and click on "Add". Fill in the form like this: Screenshot 2022-06-01 113917
    Click on "Create" and then "Customize". You can now copy your search engine id from the overview.
  4. Enter the API Key and search engine id into the two preference fields inside Squeak and click save.

You are done 🎉 You can now just type web followed something you want to search inside Algernon.