From e3c0549b88f83671bef7f4c20b87c5e413c5f71e Mon Sep 17 00:00:00 2001 From: AJ Rossini Date: Mon, 8 Oct 2012 05:35:41 +0200 Subject: [PATCH] pulled out a TODO from README, extended the TODO with that, and a few more TODOs. Signed-off-by: AJ Rossini --- README.org | 68 +++++++++++++++++++++++++++----------------------------- TODO.org | 75 +++++++++++++++++++++++++++++++++++++++++++++++++------------- 2 files changed, 93 insertions(+), 50 deletions(-) diff --git a/README.org b/README.org index 4ebdcc7..c3d1073 100644 --- a/README.org +++ b/README.org @@ -1,5 +1,5 @@ -Time-stamp: <2012-10-05 04:19:12 tony> +Time-stamp: <2012-10-08 05:34:55 tony> * Current Status: COMPLETELY BROKEN @@ -9,14 +9,15 @@ Time-stamp: <2012-10-05 04:19:12 tony> You probably did (preferred) -#+name: GitClone +#+name: LoadWithGitClone #+begin_src shell git clone git://github.com/blindglobe/common-lisp-stat.git #+end_src - or (coming soon!) from within a Lisp instance, + (or maybe using the repo.or.cz git repository archive), or (coming + soon!) from within a Lisp instance: -#+name: QuickLispLoad +#+name: LoadWithQuickLisp #+begin_src lisp (ql:quickload :cls) #+end_src @@ -153,9 +154,12 @@ dependent) or... * Local modifications, Development, Contributions + Since this project is + #+begin_src shell - git clone git://repo.or.cz/CommonLispStat.git - cd CommonLispStat +# git clone git://repo.or.cz/CommonLispStat.git + git clone git://github.com/blindglobe/common-lisp-stat.git + cd common-lisp-stat # git submodules init # git submodules update #+end_src @@ -183,6 +187,23 @@ needed by #+end_src ) +BETTER DOCUMENTATION EXAMPLES EXIST ON-LINE!! PLEASE READ THEM, THE +ABOVE IS SPARSE AND MIGHT BE OUTDATED! + + +** Contributing through GitHub + + Alternatively, one can work on the github repositories as well. + They are a bit differently organized, and require one to get a + github account and work from there. + + basically, clone the repository on github on the WWW interface, + then make a branch (as below), push back the branch to github, and + notify the main repository that there is something to be pulled. + And we'll pull it back in. + +** Commiting with the MOB on repo.or.cz + of course, perhaps you want to contribute to the mob branch. For that, after cloning the repository as above, you would: @@ -206,7 +227,7 @@ that, after cloning the repository as above, you would: ) -and it'll be put on the mob branch, as a proposal for merging. +and it'll be put on the mob branch, as a proposal for merging. Another approach would be to pull from the topic branch into the mob branch before uploading. Will work on a formal example soon. @@ -222,34 +243,11 @@ something like: ) -Alternatively, one can work on the github repositories as well. They -are a bit differently organized, and require one to get a github -account and work from there. In that case, you'd need to D/L the -libraries. - -That gets a bit tricky, but see ./bin/GetRepos.sh for an example. - -* Documentation and examples - - I've started putting examples of use in function documentation. If - you are a lisp'er, you'll find this pendantic and insulting. Many - of the uses are trivial. However, this has been tested out on a - number of research statisticians (the primary user audience) and - found useful. - - Still need to write the (run-doc-ex 'function-name) function, which - would print out the example and run it live. Hopefully with the - same results. I've used XML markup for this, but for no particular - reason, we could have used SEXPs as well. This is currently done by - using an tag set, as in - -#+srcname: -#+begin_src xml - - (progn - (example-code-for-function)) - -#+end_src +** Licensing + + Licensing will be important. Next decade. But do think through + what you intend with your contributions. Should we become famous + (Ha!) make sure that you've communicated your expectations... * Footnotes diff --git a/TODO.org b/TODO.org index 873a584..1fe61cf 100644 --- a/TODO.org +++ b/TODO.org @@ -1,5 +1,8 @@ +#+TODO: TODO CURR | DONE +#+TODO: CANCELED -Time-stamp: <2012-10-06 08:52:25 tony> + +Time-stamp: <2012-10-08 05:26:30 tony> Creation: <2008-09-08 08:06:30 tony> * Intro and Metadata @@ -93,9 +96,9 @@ current (possibly incomplete) set of lisp dependencies <2012-10-04 Thu> ?? cl-plplot : cffi -* Tasks to Do [4/21] +* Tasks to Do [2/26] - Usually, we need to load it before going on. + Usually, we need to load it everything before going on. #+name: loadit #+begin_src lisp @@ -105,14 +108,16 @@ current (possibly incomplete) set of lisp dependencies <2012-10-04 Thu> #+RESULTS: loadit | :CLS | - though sometimes we might want to recompile fully. (Can this be - done via QL? Need to check) + and sometimes we might want to recompile fully: -#+name: compile-it-all +#+name: recompile-it-all #+begin_src lisp (asdf:oos 'asdf:compile-op :cls :force T) #+end_src + Currently QuickLisp support doesn't provide a recompilation + facility. And QL is built over and partially extends ASDF, so we + should be fine for now. ** DONE [#B] SET UP - State "DONE" from "CURR" [2010-10-12 Tue 13:48] \\ @@ -125,9 +130,13 @@ current (possibly incomplete) set of lisp dependencies <2012-10-04 Thu> Pointy-headed managers need any support they can find in order to regress to their hacker-childhood. -#+name: loader -#+begin_src lisp - (in-package :cl-user) + The only point of this section is to illustrate that we could want + to load additional modules that are not a central part of the core + files. + +#+name: CustomLoader +#+begin_src lisp :tangle "examples/CustomLoader.lisp + (in-package :cl-user) ; always ensure we are in the right package to leave droppings and access functionality (progn (defun init-CLS (&key (compile 'nil)) (let ((packagesToLoad (list ;; core system @@ -148,9 +157,9 @@ current (possibly incomplete) set of lisp dependencies <2012-10-04 Thu> ;; :cl-opengl ;; :cl-glu :cl-glut :cl-glut-examples - :bordeaux-threads + ;; :cells :cells-gtk - ))) + :bordeaux-threads))) (mapcar #'(lambda (x) (if compile (asdf:oos 'asdf:compile-op x :force T) @@ -163,10 +172,13 @@ current (possibly incomplete) set of lisp dependencies <2012-10-04 Thu> #+results: | | # | -** TODO [#A] Integrate with quicklist support. - - State "TODO" from "" [2010-11-30 Tue 18:00] +** CURR [#A] Integrate with quicklist support. - important to merge with quicklisp system loader support. + important to merge with quicklisp system loader support. We + currently have some of this work integrated, but I think there are + a few systems which are not auto-installable. + + ** CURR [#A] Testing: unit, regression, examples. [0/3] - State "CURR" from "TODO" [2010-10-12 Tue 13:51] - State "TODO" from "" [2010-10-12 Tue 13:51] @@ -704,10 +716,43 @@ where (make-aa "agc9zz") ;; error expected #+end_src - ** TODO [#B] Documentation and Examples [0/3] - State "TODO" from "" [2010-10-14 Thu 00:12] + I've started putting examples of use in function documentation. If + you are a lisp'er, you'll find this pendantic and insulting. Many + of the uses are trivial. However, this has been tested out on a + number of research statisticians (the primary user audience) and + found useful. + + Still need to write the + +#+BEGIN_SRC lisp + (evaluate-documentation-example 'function-name) +#+END_SRC + + function, which would print out the example and run it live. + Hopefully with the same results. Need to setup the infrastructure, + but basically, we'd like something like: + +#+name: Example-InLineDoc +#+begin_src lisp + (cls-example-progn + (example-code-for-function-1) + (example-code-for-function-...) + (example-code-for-function-n)) +#+end_src + + and have this within the doc-string. Then the doc-string would be + parsed for the appropriate code and we'd get the results, evaluated + in a special name space derived from the object (function, class) + name, possibly with the corresponding functions and environment + set up that would be required. OR, it could just work in cl-user + (which is the default starting location. + + Here are some possible common lisp systems that could be + evaluated: + *** TODO [#B] Docudown - State "TODO" from "" [2010-11-05 Fri 15:34] -- 2.11.4.GIT