iAdding readme - cl-yag - Common Lisp Yet Another website Generator	Err	bitreich.org	70
hgit clone git://bitreich.org/cl-yag/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/cl-yag/	URL:git://bitreich.org/cl-yag/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/cl-yag/	bitreich.org	70
1Log	/scm/cl-yag/log.gph	bitreich.org	70
1Files	/scm/cl-yag/files.gph	bitreich.org	70
1Refs	/scm/cl-yag/refs.gph	bitreich.org	70
1Tags	/scm/cl-yag/tag	bitreich.org	70
1README	/scm/cl-yag/file/README.md.gph	bitreich.org	70
1LICENSE	/scm/cl-yag/file/LICENSE.gph	bitreich.org	70
i---	Err	bitreich.org	70
1commit 4df8123e33dce1823b28195c473a4a465eca4726	/scm/cl-yag/commit/4df8123e33dce1823b28195c473a4a465eca4726.gph	bitreich.org	70
1parent 66a2b83f5bceef484963bd78efc2a2da98004f4e	/scm/cl-yag/commit/66a2b83f5bceef484963bd78efc2a2da98004f4e.gph	bitreich.org	70
hAuthor: Solene Rapenne <solene@dataswamp.org>	URL:mailto:solene@dataswamp.org	bitreich.org	70
iDate:   Sat, 30 Apr 2016 17:28:12 +0200	Err	bitreich.org	70
i	Err	bitreich.org	70
iAdding readme	Err	bitreich.org	70
i	Err	bitreich.org	70
iDiffstat:	Err	bitreich.org	70
i  A README                              |      54 +++++++++++++++++++++++++++++++	Err	bitreich.org	70
i	Err	bitreich.org	70
i1 file changed, 54 insertions(+), 0 deletions(-)	Err	bitreich.org	70
i---	Err	bitreich.org	70
1diff --git a/README b/README	/scm/cl-yag/file/README.gph	bitreich.org	70
i@@ -0,0 +1,54 @@	Err	bitreich.org	70
i+Introduction	Err	bitreich.org	70
i+===	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+This blog is generated using cl-yag. It stands for Common Lisp Yet Another Generator and obviously it's written in Common Lisp.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+It has only one dependency : a common lisp interpreter, I recommend both sbcl or clisp which are free, open-source and multi-platform.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+The hierarchy	Err	bitreich.org	70
i+===	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+Here are the files and folder you can find in your project folder :	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+- **Makefile** : exists to simplify your life (updating, cleaning) 	Err	bitreich.org	70
i+- **generator.lisp** : contains all the code of the generator 	Err	bitreich.org	70
i+- **templates/** : contains .tpl files which are used as template for the html structure 	Err	bitreich.org	70
i+- **static/** : contains static files that need to be made public like images, css, js etc...	Err	bitreich.org	70
i+- **data/** : contains what will make the content of your website different from another website (or not) 	Err	bitreich.org	70
i+  - **articles.lisp** : contains metadata about the website and the list of the articles with their id/title/date/(author/short description) (aren't mandatory) 	Err	bitreich.org	70
i+  - **${id}.txt** : contains the html text of the article ${id} that will be used when displayed 	Err	bitreich.org	70
i+- **output** : this is where the websites goes when your run *make*, and where it's cleaned when you run *make clean*; 	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+How to add an article	Err	bitreich.org	70
i+===	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+Edit data/articles.lisp and add a new line inside the *articles* variable like this	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+```	Err	bitreich.org	70
i+(list :id "2" :date "29 April 2016" :title "How do I use cl-yag" :author "Solène" :short "I will explain how to use the generator")	Err	bitreich.org	70
i+```	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+The _:short_ field is used on the homepage. It it is defined, this is the text that will be shown on the homepage with all the others articles. If it's not defined, the whole article content will be used on the homepage. Sometimes when you have long articles, you may not want to display it entirely on the index so you can use _:short "view the article for the full text_.	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+The _:author_ field is used to display who wrote the article. You can omitt it, the generator will take the name from the *config* variable	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+How to use markdown for articles	Err	bitreich.org	70
i+===	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+Here is a tip to produce html files from markdown using emacs	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+ 	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+1. edit the article file with emacs using ham-mode (which is html) 	Err	bitreich.org	70
i+2. write your text with markdown syntax 	Err	bitreich.org	70
i+3. save your file (ham-mode will convert it to html inside) 	Err	bitreich.org	70
i+4. *make* to update your site 	Err	bitreich.org	70
i+	Err	bitreich.org	70
i+The generator do not do it natively because I do not want it to have dependencies. You can use what you want to produces the html files.	Err	bitreich.org	70
.