Add changelog, prepare release
This commit is contained in:
parent
fa3d7d97fe
commit
a56a8c08c1
|
@ -0,0 +1,13 @@
|
|||
v0.1 - Alpha 0.1
|
||||
======
|
||||
Wed Sep 23 14:51:17 CEST 2020
|
||||
|
||||
Preview release, the API is not yet stabilized.
|
||||
Most features are there, except support for overlays (menu, dialog windows,
|
||||
popup, ...) in Nottui.
|
||||
|
||||
Libraries included in this release:
|
||||
- Lwd, the definition of reactive documents
|
||||
- Nottui, reactive terminal interfaces using Notty & Lwd
|
||||
- Nottui-lwt, an asynchronous mainloop for Nottui
|
||||
- Tyxml-lwd, strongly-typed reactive webpages in Jsoo using Tyxml & Lwd
|
23
dune-project
23
dune-project
|
@ -1,4 +1,4 @@
|
|||
(lang dune 1.11)
|
||||
(lang dune 2.0)
|
||||
(generate_opam_files true)
|
||||
|
||||
(name lwd)
|
||||
|
@ -10,31 +10,32 @@
|
|||
(package
|
||||
(name lwd)
|
||||
(synopsis "Lightweight reactive documents")
|
||||
(description "TODO")
|
||||
(depends (dune (>= 1.11.0)) seq (ocaml (>= "4.03"))
|
||||
(documentation "https://let-def.github.io/lwd/doc")
|
||||
(depends (dune (>= 2.0)) seq (ocaml (>= "4.03"))
|
||||
(qtest :with-test)
|
||||
(qcheck :with-test)))
|
||||
|
||||
(package
|
||||
(name nottui)
|
||||
(synopsis "UI toolkit for the terminal built on top of Notty")
|
||||
(description "TODO")
|
||||
(depends (dune (>= 1.11.0)) lwd notty))
|
||||
(synopsis "UI toolkit for the terminal built on top of Notty and Lwd")
|
||||
(documentation "https://let-def.github.io/lwd/doc")
|
||||
(depends (dune (>= 2.0)) lwd notty))
|
||||
|
||||
(package
|
||||
(name tyxml-lwd)
|
||||
(synopsis "Hello")
|
||||
(description "TODO")
|
||||
(description "Make reactive webpages in Js_of_ocaml using Tyxml and Lwd")
|
||||
(documentation "https://let-def.github.io/lwd/doc")
|
||||
(depends dune lwd tyxml js_of_ocaml js_of_ocaml-ppx))
|
||||
|
||||
(package
|
||||
(name nottui-pretty)
|
||||
(synopsis "A pretty-printer based on PPrint rendering UIs")
|
||||
(description "TODO")
|
||||
(depends (dune (>= 1.11.0)) notty nottui))
|
||||
(documentation "https://let-def.github.io/lwd/doc")
|
||||
(depends (dune (>= 2.0)) notty nottui))
|
||||
|
||||
(package
|
||||
(name nottui-lwt)
|
||||
(synopsis "Run Nottui UIs in Lwt")
|
||||
(description "TODO")
|
||||
(depends (dune (>= 1.11.0)) notty lwt nottui))
|
||||
(documentation "https://let-def.github.io/lwd/doc")
|
||||
(depends (dune (>= 2.0)) notty lwt nottui))
|
||||
|
|
|
@ -2,10 +2,12 @@
|
|||
(executable
|
||||
(name cbor_explorer)
|
||||
(modules cbor_explorer)
|
||||
(modes byte exe)
|
||||
(flags :standard -warn-error -a)
|
||||
(libraries notty notty.unix nottui cbor containers))
|
||||
|
||||
(executable
|
||||
(name cbor_of_fs)
|
||||
(modules cbor_of_fs)
|
||||
(modes byte exe)
|
||||
(libraries containers cbor))
|
||||
|
|
|
@ -1,25 +1,30 @@
|
|||
(executable
|
||||
(name minimal)
|
||||
(modules minimal)
|
||||
(modes byte exe)
|
||||
(libraries notty notty.unix nottui))
|
||||
|
||||
(executable
|
||||
(name misc)
|
||||
(modules misc)
|
||||
(modes byte exe)
|
||||
(libraries notty notty.unix nottui))
|
||||
|
||||
(executable
|
||||
(name reranger)
|
||||
(modules reranger)
|
||||
(modes byte exe)
|
||||
(libraries notty notty.unix nottui))
|
||||
|
||||
(executable
|
||||
(name stress)
|
||||
(modules stress)
|
||||
(modes byte exe)
|
||||
(libraries notty notty.unix nottui))
|
||||
|
||||
(executable
|
||||
(name pretty)
|
||||
(modules pretty)
|
||||
(modes byte exe)
|
||||
(libraries nottui-pretty notty notty.unix nottui))
|
||||
|
||||
|
|
|
@ -105,7 +105,7 @@ val observe : ?on_invalidate:('a -> unit) -> 'a t -> 'a root
|
|||
|
||||
val set_on_invalidate : 'a root -> ('a -> unit) -> unit
|
||||
(** Change the callback for the root.
|
||||
@see observe for more details. *)
|
||||
See [observe] for more details. *)
|
||||
|
||||
val sample : release_queue -> 'a root -> 'a
|
||||
(** Force the computation of the value for this root.
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
(** {0 Sequence manipulation}
|
||||
(** {1 Sequence manipulation}
|
||||
|
||||
[Lwd_seq] is an ordered collection with a pure interface.
|
||||
Changes to collections are easy to track.
|
||||
|
@ -16,7 +16,7 @@ type +'a t
|
|||
type +'a seq = 'a t
|
||||
(** The type of sequences *)
|
||||
|
||||
(** {1 Primitive constructors} *)
|
||||
(** {2 Primitive constructors} *)
|
||||
|
||||
val empty : 'a seq
|
||||
(** A sequence with no element. *)
|
||||
|
@ -40,7 +40,7 @@ val concat : 'a seq -> 'a seq -> 'a seq
|
|||
reuse.
|
||||
*)
|
||||
|
||||
(** {1 Looking at sequence contents} *)
|
||||
(** {2 Looking at sequence contents} *)
|
||||
|
||||
type ('a, 'b) view =
|
||||
| Empty
|
||||
|
@ -50,7 +50,7 @@ type ('a, 'b) view =
|
|||
val view : 'a seq -> ('a, 'a seq) view
|
||||
(** View how a sequence is defined *)
|
||||
|
||||
(** {1 Conversion between sequences, lists and arrays} *)
|
||||
(** {2 Conversion between sequences, lists and arrays} *)
|
||||
|
||||
val transform_list : 'a list -> ('a -> 'b seq) -> 'b seq
|
||||
(** Produce a sequence by transforming each element of a list and concatenating
|
||||
|
@ -72,7 +72,7 @@ val to_list : 'a seq -> 'a list
|
|||
val to_array : 'a seq -> 'a array
|
||||
(** Produce an array from a sequence *)
|
||||
|
||||
(** {1 Balanced variant of sequences *)
|
||||
(** {2 Balanced variant of sequences} *)
|
||||
|
||||
module Balanced : sig
|
||||
|
||||
|
@ -108,7 +108,7 @@ module Balanced : sig
|
|||
val view : 'a t -> ('a, 'a t) view
|
||||
end
|
||||
|
||||
(** {1 Transforming sequences} *)
|
||||
(** {2 Transforming sequences} *)
|
||||
|
||||
(**
|
||||
All sequences live in [Lwd] monad: if a sequence changes slightly, parts
|
||||
|
@ -155,7 +155,7 @@ val monoid : 'a t Lwd_utils.monoid
|
|||
val lwd_monoid : 'a t Lwd.t Lwd_utils.monoid
|
||||
(** Monoid instance for reactive sequences *)
|
||||
|
||||
(** {1 Low-level interface for observing changes} *)
|
||||
(** {2 Low-level interface for observing changes} *)
|
||||
|
||||
module Reducer : sig
|
||||
(* The interface allows to implement incremental sequence transformation
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
(** {0 Table manipulation}
|
||||
(** {1 Table manipulation}
|
||||
|
||||
[Lwd_table] is an ordered collection with an impure interface.
|
||||
It is designed to be efficient in an interactive setting.
|
||||
|
@ -18,7 +18,7 @@ type 'a row
|
|||
val make : unit -> 'a t
|
||||
(** Create a new table *)
|
||||
|
||||
(** {1 Inserting rows} *)
|
||||
(** {2 Inserting rows} *)
|
||||
|
||||
val prepend : ?set:'a -> 'a t -> 'a row
|
||||
(** Insert and return a new row at the start of a table.
|
||||
|
@ -50,7 +50,7 @@ val after : ?set:'a -> 'a row -> 'a row
|
|||
too.
|
||||
*)
|
||||
|
||||
(** {1 Iterating over rows} *)
|
||||
(** {2 Iterating over rows} *)
|
||||
|
||||
val first : 'a t -> 'a row option
|
||||
(** Returns the first row of a table, or [None] if the table is empty *)
|
||||
|
@ -66,7 +66,7 @@ val prev : 'a row -> 'a row option
|
|||
(** Returns the row just before another one, or [None] if the input row is
|
||||
unbound or is the first row *)
|
||||
|
||||
(** {1 Accessing and changing row contents} *)
|
||||
(** {2 Accessing and changing row contents} *)
|
||||
|
||||
val get : 'a row -> 'a option
|
||||
(** Get the value associated with a row, if any, or [None] if the row is
|
||||
|
@ -78,7 +78,7 @@ val set : 'a row -> 'a -> unit
|
|||
val unset : 'a row -> unit
|
||||
(** Unset the value associated with a row *)
|
||||
|
||||
(** {1 Removing rows} *)
|
||||
(** {2 Removing rows} *)
|
||||
|
||||
val is_bound : 'a row -> bool
|
||||
(** Returns [true] iff the row is bound in a table (it has not beem [remove]d
|
||||
|
@ -90,7 +90,7 @@ val remove : 'a row -> unit
|
|||
val clear : 'a t -> unit
|
||||
(** Remove all rows from a table *)
|
||||
|
||||
(** {1 Observing table contents} *)
|
||||
(** {2 Observing table contents} *)
|
||||
|
||||
val reduce : 'a Lwd_utils.monoid -> 'a t -> 'a Lwd.t
|
||||
(** Observe the content of a table by reducing it with a monoid *)
|
||||
|
|
4
lwd.opam
4
lwd.opam
|
@ -1,14 +1,14 @@
|
|||
# This file is generated by dune, edit dune-project instead
|
||||
opam-version: "2.0"
|
||||
synopsis: "Lightweight reactive documents"
|
||||
description: "TODO"
|
||||
maintainer: ["fred@tarides.com"]
|
||||
authors: ["Frédéric Bour"]
|
||||
license: "MIT"
|
||||
homepage: "https://github.com/let-def/lwd"
|
||||
doc: "https://let-def.github.io/lwd/doc"
|
||||
bug-reports: "https://github.com/let-def/lwd/issues"
|
||||
depends: [
|
||||
"dune" {>= "1.11.0"}
|
||||
"dune" {>= "2.0"}
|
||||
"seq"
|
||||
"ocaml" {>= "4.03"}
|
||||
"qtest" {with-test}
|
||||
|
|
|
@ -1,14 +1,14 @@
|
|||
# This file is generated by dune, edit dune-project instead
|
||||
opam-version: "2.0"
|
||||
synopsis: "Run Nottui UIs in Lwt"
|
||||
description: "TODO"
|
||||
maintainer: ["fred@tarides.com"]
|
||||
authors: ["Frédéric Bour"]
|
||||
license: "MIT"
|
||||
homepage: "https://github.com/let-def/lwd"
|
||||
doc: "https://let-def.github.io/lwd/doc"
|
||||
bug-reports: "https://github.com/let-def/lwd/issues"
|
||||
depends: [
|
||||
"dune" {>= "1.11.0"}
|
||||
"dune" {>= "2.0"}
|
||||
"notty"
|
||||
"lwt"
|
||||
"nottui"
|
||||
|
|
|
@ -1,16 +1,15 @@
|
|||
# This file is generated by dune, edit dune-project instead
|
||||
opam-version: "2.0"
|
||||
synopsis: "A pretty-printer based on PPrint rendering UIs"
|
||||
description: "TODO"
|
||||
maintainer: ["fred@tarides.com"]
|
||||
authors: ["Frédéric Bour"]
|
||||
license: "MIT"
|
||||
homepage: "https://github.com/let-def/lwd"
|
||||
doc: "https://let-def.github.io/lwd/doc"
|
||||
bug-reports: "https://github.com/let-def/lwd/issues"
|
||||
depends: [
|
||||
"dune" {>= "1.11.0"}
|
||||
"dune" {>= "2.0"}
|
||||
"notty"
|
||||
"lwt"
|
||||
"nottui"
|
||||
]
|
||||
build: [
|
||||
|
|
|
@ -1,14 +1,14 @@
|
|||
# This file is generated by dune, edit dune-project instead
|
||||
opam-version: "2.0"
|
||||
synopsis: "UI toolkit for the terminal built on top of Notty"
|
||||
description: "TODO"
|
||||
synopsis: "UI toolkit for the terminal built on top of Notty and Lwd"
|
||||
maintainer: ["fred@tarides.com"]
|
||||
authors: ["Frédéric Bour"]
|
||||
license: "MIT"
|
||||
homepage: "https://github.com/let-def/lwd"
|
||||
doc: "https://let-def.github.io/lwd/doc"
|
||||
bug-reports: "https://github.com/let-def/lwd/issues"
|
||||
depends: [
|
||||
"dune" {>= "1.11.0"}
|
||||
"dune" {>= "2.0"}
|
||||
"lwd"
|
||||
"notty"
|
||||
]
|
||||
|
|
|
@ -1,11 +1,12 @@
|
|||
# This file is generated by dune, edit dune-project instead
|
||||
opam-version: "2.0"
|
||||
synopsis: "Hello"
|
||||
description: "TODO"
|
||||
description: "Make reactive webpages in Js_of_ocaml using Tyxml and Lwd"
|
||||
maintainer: ["fred@tarides.com"]
|
||||
authors: ["Frédéric Bour"]
|
||||
license: "MIT"
|
||||
homepage: "https://github.com/let-def/lwd"
|
||||
doc: "https://let-def.github.io/lwd/doc"
|
||||
bug-reports: "https://github.com/let-def/lwd/issues"
|
||||
depends: ["dune" "lwd" "tyxml" "js_of_ocaml" "js_of_ocaml-ppx"]
|
||||
build: [
|
||||
|
|
Loading…
Reference in New Issue