From 361d6c7e2d879bab5a05a58178f6863b96b1b5f0 Mon Sep 17 00:00:00 2001 From: "the Phoeron\" Colin J.E. Lupton" <thephoeron@protonmail.com> Date: Wed, 31 Aug 2022 07:56:42 -0400 Subject: [PATCH] Replace default GitLab Pages README.md with relevant sections from the title page --- README.md | 126 ++++++++++++++++++++++-------------------------------- 1 file changed, 50 insertions(+), 76 deletions(-) diff --git a/README.md b/README.md index 31a29f8..2ece761 100644 --- a/README.md +++ b/README.md @@ -1,104 +1,78 @@ - +# Learn Lisp The Hard Way ---- +[](https://zenodo.org/badge/latestdoi/15644205) -Example [GitBook] website using GitLab Pages. +```lisp +;; Welcome to L(λ)THW! +(let ((llthw '(learn lisp the hard way))) + (format t "~{~@(~A~)~^ ~}, because ~{~A~^ ~} is easier!" llthw (cddr llthw))) -Learn more about GitLab Pages at https://pages.gitlab.io and the official -documentation https://docs.gitlab.com/ce/user/project/pages/. +;; Common Lisp: Powerful, Expressive, Programmable, General Purpose, Multi-Paradigm. +``` ---- +This is the source-control repository for *Learn Lisp The Hard Way* (LLTHW), an +introduction to the Common Lisp programming language by "the Phoeron" Colin J.E. +Lupton, in the style of Zed Shaw's LxTHW series. -<!-- START doctoc generated TOC please keep comment here to allow auto update --> -<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* +You can read the Second Draft (in-progress) of LLTHW online at: -- [GitLab CI](#gitlab-ci) -- [Building locally](#building-locally) -- [GitLab User or Group Pages](#gitlab-user-or-group-pages) -- [Did you fork this project?](#did-you-fork-this-project) -- [Troubleshooting](#troubleshooting) +https://llthw.common-lisp.dev -<!-- END doctoc generated TOC please keep comment here to allow auto update --> +## Supporting This Project -## GitLab CI +If you would like to show your support for LLTHW, please consider sponsoring the +author through GitHub Sponsors: -This project's static Pages are built by [GitLab CI][ci], following the steps -defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): +https://github.com/sponsors/thephoeron -```yaml -# requiring the environment of NodeJS 8.9.x LTS (carbon) -image: node:8.9 +## Recent Updates -# add 'node_modules' to cache for speeding up builds -cache: - paths: - - node_modules/ # Node modules and dependencies +LLTHW is under active development and changes often. For a +list of recent updates, please see the [CHANGELOG](./CHANGELOG.md), and for a +summary of upcoming changes to look out for, please see the [TODO](./TODO.md) +list. -before_script: - - npm install gitbook-cli -g # install gitbook - - gitbook fetch latest # fetch latest stable version - - gitbook install # add any requested plugins in book.json - #- gitbook fetch pre # fetch latest pre-release version - #- gitbook fetch 2.6.7 # fetch specific version +You can also check the commit history directly on the source-control repository +at: -# the 'pages' job will deploy and build your site to the 'public' path -pages: - stage: deploy - script: - - gitbook build . public # build to public path - artifacts: - paths: - - public - only: - - master # this job will affect only the 'master' branch -``` +https://gitlab.common-lisp.net/llthw/llthw.common-lisp.dev/-/commits/master + +Updates to the LLTHW repository are automatically built and deployed to the live +server, typically within 5 minutes or less. -## Building locally +## Issues -To work locally with this project, you'll have to follow the steps below: +To report technical problems with the content of this book, please create an +Issue on the source-control repository at: -1. Fork, clone or download this project -1. [Install][] GitBook `npm install gitbook-cli -g` -1. Fetch GitBook's latest stable version `gitbook fetch latest` -1. Preview your project: `gitbook serve` -1. Add content -1. Generate the website: `gitbook build` (optional) -1. Push your changes to the master branch: `git push` +https://gitlab.common-lisp.net/llthw/llthw.common-lisp.dev/-/issues -Read more at GitBook's [documentation][]. +## Past Contributors -## GitLab User or Group Pages +Past contributors from the Toronto Lisp User Group no longer involved in the +project include: -To use this project as your user/group website, you will need one additional -step: just rename your project to `namespace.gitlab.io`, where `namespace` is -your `username` or `groupname`. This can be done by navigating to your -project's **Settings**. +- Leo "Inaimathi" Zovic +- Dann Toliver +- Gaelen D'Costa +- Josh Teneycke -Read more about [user/group Pages][userpages] and [project Pages][projpages]. +## LxTHW Repository -## Did you fork this project? +Zed Shaw released a "Learn X The Hard Way" open-source project so that anyone +could write an introductory book for their favourite programming language in the +style of the Learn Code The Hard Way series. -If you forked this project for your own use, please go to your project's -**Settings** and remove the forking relationship, which won't be necessary -unless you want to contribute back to the upstream project. +A fork of the original gitorious repo can be found at: -## Troubleshooting +https://github.com/laszlocsontos/learn-x-the-hard-way -1. CSS is missing! That means two things: +You can learn more about the Learn Code The Hard Way series at: - Either that you have wrongly set up the CSS URL in your templates, or - your static generator has a configuration option that needs to be explicitly - set in order to serve static assets under a relative URL. +https://learncodethehardway.org ----- +## License -Forked from @virtuacreative +<span xmlns:dct="https://purl.org/dc/terms/" property="dct:title">Learn Lisp The Hard Way</span> by <a xmlns:cc="https://creativecommons.org/ns#" href="https://thephoeron.common-lisp.dev" property="cc:attributionName" rel="cc:attributionURL">"the Phoeron" Colin J.E. Lupton</a> is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-nd/4.0/">Creative Commons Attribution-NoDerivatives 4.0 International License</a>. -[ci]: https://about.gitlab.com/gitlab-ci/ -[GitBook]: https://www.gitbook.com/ -[host the book]: https://gitlab.com/pages/gitbook/tree/pages -[install]: http://toolchain.gitbook.com/setup.html -[documentation]: http://toolchain.gitbook.com -[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages -[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages +<center><a rel="license" href="https://creativecommons.org/licenses/by-nd/4.0/"><img alt="Creative Commons License" style="border-width:0;" src="https://i.creativecommons.org/l/by-nd/4.0/88x31.png" /></a></center> -- GitLab