jsjolen / cl-cookbook

The Common Lisp Cookbook

Lisp Cookbook

This is a fork of the Common Lisp Cookbook, moved from SourceForge.

This project will bring Common Lisp Cookbook to this decade. Development of the original Common Lisp Cookbook in SourceForge halted in 2007. In the meantime, a lot has happened in the land of Common Lisp. Tools and implementations have been improving, and some have fallen out of favor. Most notably, Common Lisp users can now benefit from Quicklisp library manager.

The main goal is making the Cookbook more modern and more accessible in addition to updating and expanding the content. Cookbook is an invaluable resource, as it shows in very to the point manner how to do various things in clear fashion without all the theoretical context. Sometimes you just need to look things up. While cookbooks can never replace proper documentation such as HyperSpec or books such as Practical Common Lisp, every language deserves a good cookbook, Common Lisp included.

Contributing

When adding a new content, ensure, it renders propertly.

There are two ways to do this:

First option is to install Jekyll and run jekyll serve in a folder where this repository was checked out.

Another option is to use github gem provided with the repo. To do this do the following:

1. Ensure that bundler is installed (gem install bundler should do)
2. bundle install --path vendor/bundle
3. bundle exec jekyll serve

Troubleshooting

It can happen that you have older version of ruby installed in the system and bundler will fail with install. To fix this you need to update ruby. Sometimes system update is not an option, in this case consider instaling rbenv.

    # Check rbenv homepage for install instructions on systems other than Mac OS X
    brew install rbenv ruby-build

    # Add rbenv to bash so that it loads every time you open a terminal
    echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
    source ~/.bash_profile

    # Install Ruby
    rbenv install 2.5.0
    rbenv global 2.5.0
    ruby -v

After this you can proceed as usual:

1. gem install bundler
2. bundle install --path vendor/bundle
3. bundle exec jekyll serve

Also, refer to a CONTRIBUTING.md file.