changelog shortlog graph tags branches changeset files file revisions raw help

Mercurial > demo / annotate readme.org

changeset 19: fd19fdc77a20
parent: a1137af05c8d
child: ba323d8c0f93
author: ellis <ellis@rwest.io>
date: Mon, 29 May 2023 21:55:22 -0400
permissions: -rw-r--r--
description: readme update, removed scripts dir
0
ellis <ellis@rwest.io>
parents:
diff changeset
1
 #+TITTLE: cl-demo
ellis <ellis@rwest.io>
parents:
diff changeset
2
 This is a demo software suite which showcases the power of Common Lisp and Rust.
14
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
3
 * Guide
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
4
 ** Build
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
5
 - *install dependencies*
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
6
   - Rust =curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh=
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
7
   - Common Lisp
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
8
     - on Linux ::
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
9
       - Ubuntu/Debian :: =sudo apt-get install sbcl=
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
10
       - Arch BTW :: =sudo pacman -S sbcl=
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
11
     - on MacOS :: =brew install sbcl=
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
12
     - on Windows :: download from
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
13
       <https://www.sbcl.org/platform-table.html> and figure it out.
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
14
   - Quiche
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
15
   - RocksDB
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
16
 - *make executables* \\
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
17
   Simply run =make build=. Read the ~makefile~ and change the options
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
18
   as needed.
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
19
 - M :: Mode (debug, release)
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
20
 - L :: Lisp (sbcl, cmucl, ccl)
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
21
 - P :: Python (python3, python2)
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
22
 ** Run
18
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
23
 #+begin_src shell
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
24
   make build
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
25
   ./out/demo
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
26
 #+end_src
14
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
27
 ** Config
19
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
28
 Configs can be specified in JSON, TOML, RON, or of course SEXP.
14
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
29
 ** Play
19
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
30
 The high-level user interface is presented as a multi-modal GUI
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
31
 application which adapts to the specific application /instances/
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
32
 below.
14
2bbf5ce73537 rs updates
ellis <ellis@rwest.io>
parents: 9
diff changeset
33
 *** Weather
18
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
34
 This backend retrieves weather data using the NWS API.
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
35
 *** Stocks
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
36
 The 'Stocks' backend features a stock ticker with real-time analysis
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
37
 capabilities.
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
38
 *** Bench
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
39
 This is a benchmark backend for testing the capabilities of our
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
40
 demo. It spins up some mock services and allows fine-grained control
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
41
 of input/throughput.
8
bebb76da449c tests and stuff
ellis <ellis@rwest.io>
parents: 3
diff changeset
42
 * tasks
9
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
43
 ** TODO DSLs
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
44
 - consider tree-sitter parsing layout, use as a guide for developing a
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
45
   single syntax which expands to Rust or C.
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
46
 - with-rs
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
47
 - with-c
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
48
 - with-rs/c
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
49
 - with-cargo
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
50
 - compile-rs/c
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
51
 *** TODO rs-macroexpand
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
52
 - rs-gen-file
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
53
 - rs-defmacro
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
54
 - rs-macros
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
55
 - rs-macroexpand
8
bebb76da449c tests and stuff
ellis <ellis@rwest.io>
parents: 3
diff changeset
56
 - rs-macroexpand-1
9
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
57
 *** TODO c-macroexpand
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
58
 - c-gen-file h/c
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
59
 - c-defmacro
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
60
 - c-macros
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
61
 - c-macroexpand
b9720ba9c4a0 readme, removed redundant script
ellis <ellis@rwest.io>
parents: 8
diff changeset
62
 - c-macroexpand-1
18
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
63
 *** TODO slint-macroexpand
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
64
 - slint-gen-file
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
65
 - slint-defmacro
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
66
 - slint-macros
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
67
 - slint-macroexpand
a1137af05c8d removed fig, use sexprs instead
ellis <ellis@rwest.io>
parents: 14
diff changeset
68
 - slint-macroexpand-1
19
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
69
 *** TODO html (using who)
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
70
 ** TODO web templates
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
71
 create a basic static page in CL which will be used to host Slint UIs
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
72
 and other WASM doo-dads in a browser.
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
73
 ** TODO CLI
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
74
 using clingon, decide on generic options and write it up
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
75
 ** TODO docs
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
76
 work on doc generation -- Rust and CL should be accounted for.
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
77
 ** TODO tests
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
78
 We have none! need to make it more comfy - set up testing in all Rust
fd19fdc77a20 readme update, removed scripts dir
ellis <ellis@rwest.io>
parents: 18
diff changeset
79
 crates and for the lisp systems.