Browse Source

initial write-up in README (change from .md to .org).

Outlines the project's goals, description, pre-requisites Etc.
master
Craig Oates 2 years ago
parent
commit
a29a025a79
  1. 3
      README.md
  2. 85
      README.org

3
README.md

@ -1,3 +0,0 @@
# rails-to-caveman
A website built in Common Lisp using Caveman2 as its framework. It is based on a collection of tutorials written by hyotang666. Those tutorials are based on chapters from the book 'Basic Ruby on Rails'. hyotang666 ported the Ruby code to Common Lisp.

85
README.org

@ -0,0 +1,85 @@
#+options: ':nil *:t -:t ::t <:t H:3 \n:nil ^:t arch:headline
#+options: author:t broken-links:nil c:nil creator:nil
#+options: d:(not "LOGBOOK") date:t e:t email:nil f:t inline:t num:t
#+options: p:nil pri:nil prop:nil stat:t tags:t tasks:t tex:t
#+options: timestamp:t title:t toc:t todo:t |:t
#+title: Rails to Caveman Read Me
#+date: 2021-12-10 Fri
#+author: Craig Oates
#+email: craig@craigoates.net
#+language: en
#+select_tags: export
#+exclude_tags: noexport
#+creator: Emacs 27.1 (Org mode 9.4.6)
* Summary
A website built in Common Lisp using Caveman2 as its framework. It
is based on a collection of tutorials written by [[https://github.com/hyotang666/hyotang666.github.io][hyotang666]]. Those
tutorials are based on chapters from the book, [[https://book-impress-co-jp.translate.goog/books/1117101135?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Basic Ruby on
Rails]]. hyotang666 ported the Ruby code to Common Lisp.
This repository is for learning how to use Caveman2 and get more
experience with Common Lisp. If all goes/gone well, this should be a
useful reference repository for future web-based projects -- with
Caveman2 and Common Lisp as the main technologies used, obviously.
The code in this repository will refrain from having 'chapter'
separations in it. My intention is to follow the chapters and create
an entire website which looks like a 'normal' code-base.
I originally found the tutorial at [[https://www.reddit.com/r/Common_Lisp/comments/p0s0bl/series_of_tutorials_on_building_a_website_using/][Reddit]]'s 'r/Common_Lisp'.
* Pre-Requisites
- [[https://hyotang666-github-io.translate.goog/archives/caveman.0.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Caveman Kills Ruby on Rails -- Chapter 0]] (Google Translated
version, original in Japanese)
Before I start, I should point out hyotang666 has provided a
'Chapter 0' with his tutorials. In it, he lays out things like the
target audience and his motivation for writing the
tutorials. *hyotang666 states these tutorials are not for Common
Lisp beginners* so you will need some experience with Common Lisp
before you getting stuck into either this repository or hyotang666's
tutorials.
In terms of my set-up, I am using the following:
- Emacs
- The Superior Lisp Interaction Mode for Emacs (SLIME)
- Steel Bank Common Lisp Compiler (SBCL)
The set-up and usage of these tools are out of scope for this file
and project. If you are unfamiliar with the items listed above, this
repository is most likely too early in your Common Lisp learning
journey -- or of little use to you in-general.
The list Common Lisp packages used in this repository reside in the
=rails-to-caveman.asd= file. I will not list them here because there
is a high chance a way of them getting out of sync. with the actual
code.
* Translated Chapter Links
Because the original chapters are in Japanese, I had to use Google
Translate so I could read them. Below are a list of links to each
chapter. *Note, the code in this repository will not specify which
chapter it came from*. The list below is for further reading and
nothing else.
- [[https://hyotang666-github-io.translate.goog/archives/caveman.0.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 0]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.1.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 1]]
- /I could not find a Chapter 2 or a link for it/
- [[https://hyotang666-github-io.translate.goog/archives/caveman.3.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 3]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.4.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 4]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.5.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 5]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.6.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 6]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.7.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 7]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.8.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 8]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.9.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 9]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.10.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 10]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.11.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 11]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.12.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 12]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.12.5.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 12.5]] /(yes, there is a Chapter 12.5)/
- [[https://hyotang666-github-io.translate.goog/archives/caveman.13.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 13]]
- [[https://hyotang666-github-io.translate.goog/archives/caveman.14.html?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=en-GB][Chapter 14]]
Loading…
Cancel
Save