dev.metalisp.survey/README.md

Table of Contents

1. dev.metalisp.survey
   1. Introduction
   2. Dependencies
   3. Mailing list
   4. Issue tracker
   5. News Feed
   6. Installation instructions
      1. 1. Install a Common Lisp implementation
      2. 2. Set up ASDF
      3. 3. Organize your project directory
      4. 4. Configure ASDF to find your project
      5. 5. Load your project
      6. 6. Run your project
      7. Optional: Example Initialization in .sbclrc
   7. License

dev.metalisp.survey

Introduction

I am developing a simple web application in Common Lisp that facilitates the execution of the System Usability Scale (SUS) questionnaire. This app allows users to easily conduct usability evaluations by presenting the standard SUS questions and collecting responses. The goal is to streamline the process of gathering and analyzing usability feedback.

Dependencies

• https://github.com/edicl/hunchentoot
• https://git.sr.ht/~marcuskammer/dev.metalisp.sbt

Mailing list

• https://lists.sr.ht/~marcuskammer/dev.metalisp.survey

Issue tracker

• https://todo.sr.ht/~marcuskammer/dev.metalisp.survey

News Feed

• https://git.sr.ht/~marcuskammer/dev.metalisp.survey/log/main/rss.xml

Installation instructions

1. Install a Common Lisp implementation

• Ensure you have a Common Lisp implementation installed. Common options include SBCL (Steel Bank Common Lisp) and CCL (Clozure Common Lisp). You can download and install them from their respective websites:
  • SBCL
  • CCL

2. Set up ASDF

• ASDF is typically bundled with modern Lisp implementations. However, if it’s not present, you can download it from ASDF’s repository.

3. Organize your project directory

• Place the dev.metalisp.survey project in the ~/common-lisp directory. Ensure the directory structure looks like this:

  ~/common-lisp/
    └── dev.metalisp.survey/
        ├── dev.metalisp.survey.asd
        └── src/
            └── app.lisp
  

4. Configure ASDF to find your project

• Open your Common Lisp REPL and run the following commands to set up the ASDF central registry:

  ;; Ensure ASDF is loaded
  (require :asdf)
  
  ;; Add ~/common-lisp to the ASDF central registry
  (push #p"~/common-lisp/" asdf:*central-registry*)
  

5. Load your project

• In your REPL, load the project by running:

  (asdf:load-system :dev.metalisp.survey)
  

6. Run your project

• After loading the system, you can run the main function or entry point of the project. dev.metalisp.survey:start, you would execute:

  (dev.metalisp.survey:start)
  

Optional: Example Initialization in .sbclrc

To make the ASDF configuration persistent across REPL sessions, you can add the setup to your .sbclrc file:

1. Edit .sbclrc

   • Open (or create) the .sbclrc file in your home directory and add the following lines:

     (require :asdf)
     (push #p"~/common-lisp/" asdf:*central-registry*)
     

2. Reload SBCL

   • The next time you start SBCL, it will automatically include the ~/common-lisp directory in the ASDF central registry.

License

MIT