From f1834341a9383c8c1184f0cd5846839051b8d0b2 Mon Sep 17 00:00:00 2001 From: NunoSempere Date: Sat, 23 Sep 2023 22:19:59 +0100 Subject: [PATCH] update README, end for the day. --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fd2af7a..cda8453 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ squiggle.c is a self-contained C99 library that provides functions for simple Mo - Because if you can implement something in C, you can implement it anywhere else - Because it can be made faster if need be - e.g., with a multi-threading library like OpenMP, - - or by implementing faster but more complex algorithms + - o by implementing faster but more complex algorithms - or more simply, by inlining the sampling functions (adding an `inline` directive before their function declaration) - **Because there are few abstractions between it and machine code** (C => assembly => machine code with gcc, or C => machine code, with tcc), leading to fewer errors beyond the programmer's control. @@ -34,7 +34,7 @@ You can follow some example usage in the examples/ folder ### squiggle.c is short -[squiggle.c](squiggle.c) is less than 500 lines of C. The reader could just read it and grasp its contents. +[squiggle.c](squiggle.c) is less than 600 lines of C, with a core of <250 lines. The reader could just read it and grasp its contents. ### Core strategy @@ -345,8 +345,9 @@ It emits one warning about something I already took care of, so by default I've - [x] Add prototypes - [x] Use named structs - [x] Add to header file - - [ ] Provide example + - [x] Provide example - [ ] Test results - [ ] Add conversion between 90% ci and parameters. - - [ ] Move to own file? Or signpost in file? + - [x] Move to own file? Or signpost in file? => signposted in file. - [ ] Disambiguate sample_laplace--successes vs failures || successes vs total trials as two distinct and differently named functions +- [ ] Write twitter thread.