Skip to content

Write INSTALLATION.md #5

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

Open
rikedyp opened this issue Apr 4, 2025 · 4 comments
Open

Write INSTALLATION.md #5

rikedyp opened this issue Apr 4, 2025 · 4 comments

Comments

@rikedyp
Copy link
Collaborator

rikedyp commented Apr 4, 2025

Until there is a runner, all users are required to run APL locally or on TryAPL.org to try exercises. Instructions need to be written and included in the docs folder as per the exercism docs.

@rikedyp rikedyp changed the title Write set up instructions Write INSTALLATION.md Apr 5, 2025
@rikedyp
Copy link
Collaborator Author

rikedyp commented Apr 6, 2025

Will advise users to install Dyalog for use locally so that they can then use ]Get to retrieve the test cases for exercises. Currently unsure what "submitting" exercises looks like, but presumably it involves uploading a .aplf file for now.

@jonocarroll
Copy link
Collaborator

If users work locally, they use the exercism cli tool which pulls down the requested exercise and test file into a configured workspace/track/exercise directory, e.g. exercism download --track=apl --exercise=hello-world results in <workspace>/apl/hello-world containing:

  • HELP.md (track-specific help)
  • README.md (exercise-specific help)
  • hello-world.alpf (template solution)
  • test_hello-world.aplf (tests).

They should be able to test with exercism test at the command line in the relevant directory. They then submit their exercise with exercism submit hello-world.aplf.

As a user, I'd like to see instructions for downloading the runtime and probably RIDE for editing; setting up the appropriate directory so that I can just )ed ./hello-world.aplf and edit my solution (including that instruction). It might be really helpful if dyalogscript was able to run the test file, but otherwise the ]Get Test_exercise.aplf and Test_exercise lines should be documented.

Some users may prefer to edit their solution on TryAPL.org, but I don't think we need to link out to a repo for any files at any point. The online editor will allow them to paste in solutions copied out of TryAPL.org and see if they pass the tests.

rikedyp added a commit that referenced this issue Apr 7, 2025
@rikedyp
Copy link
Collaborator Author

rikedyp commented Apr 7, 2025

Okay now I think ]Link will be the recommended way to develop solutions. We can provide a dyalogscript that can run tests from a command line and hopefully can integrate with the exercism test command.

Once the folder is downloaded via the exercism cli, you can do like this:

      ]LINK.Create # C:\Users\rpark\Documents\GitHub\exercism\exercises\practice\acronym
Linked: # ←→ C:\Users\rpark\Documents\GitHub\exercism\exercises\practice\acronym
      ]names
Acronym Test_Acronym 

Editing Acronym or Test_Acronym in the Dyalog editor will also update the files, so submission shouldn't require any extra steps. We will include info about the exercism test and dyalogscript stuff which would be more for people who prefer to code entirely in a text editor (but will not have the debugging capabilities of Ride or the Windows IDE).

@jonocarroll
Copy link
Collaborator

This seems to work well, albeit removing the need for the 2⎕FIX approach since the solution is defined in the workspace - I'll remove those lines from the test files.

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