Change LICENSE, add DEVELOP.md

DEVELOP.md

@@ -0,0 +1,38 @@
+# `niivue-react` Development
+
+This document explains how to develop and contribute code to `niivue-react`.
+
+## Installation
+
+Install [`pnpm`](https://pnpm.io/installation), clone the repository, then run
+
+```shell
+pnpm i
+```
+
+To set up the example for development, run
+
+```shell
+cd examples
+pnpm i
+pnpm link ../niivue-react
+pnpm run dev
+```
+
+## Code Organization
+
+- `model.ts`: defines types
+- `diff.ts`: helper functions for doing reconciliation from actual state to desired state.
+  It's somewhat analogous to React's internal "diff" algorithm which updates the virtual DOM.
+  Here, we do a diff between objects to compute which mutable setter functions of Niivue to call,
+  which in turn update the canvas. As a programming habit, the functions of `diff.ts` are pure functions.
+- `diff.test.ts`: tests and examples
+- `NiivueCanvas.tsx`: defines `<NiivueCanvas />`; tight coupling between the functions of `diff.ts` to the React library and Niivue.
+- `playwright/NiivueCanvas.story.tsx`: a wrapper around `<NiivueCanvas />` to enable Playwright component testing.
+- `tests/playwright/NiivueCanvas.test.tsx`: tests for `<NiivueCanvas />` using Playwright
+
+## TODO
+
+- [ ] publish package to NPM
+- [ ] generate and publish documentation
+- [ ] test coverage

LICENSE

@@ -1,21 +1,24 @@
-MIT License
+BSD 2-Clause License
 
-Copyright (c) 2023 FNNDSC / BCH
+Copyright (c) 2024, Niivue
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,12 +1,14 @@
 # niivue-react
 
-INCOMPLETE WORK IN PROGRESS.
-
-What's working: volumes, Niivue options. What's not: meshes. (In theory, we're already 90% the way there with mesh support.)
-
 `niivue-react` is a package which provides `<NiivueCanvas />`, a React component wrapper around `Niivue`
 offering an immutable, declarative API.
 
+## :construction: WORK IN PROGRESS :construction:
+
+- What's working: volumes, Niivue options.
+- What's tested: volumes
+- What's not: meshes. (In theory, we're already 90% the way there with mesh support.)
+
 ## Abstract
 
 [Niivue](https://github.com/niivue/niivue) is a web-based medical image viewer. The `<NiivueCanvas />`
@@ -148,31 +150,6 @@ where `ventricle` is the volume we want to change.
 Please checkout [ModulateScalar.tsx](example/src/ModulateScalar.tsx), which is a rewrite of
 [Niivue's modulateScalar.html](https://github.com/niivue/niivue/blob/main/demos/features/modulateScalar.html).
 
-## Developing
-
-Install [`pnpm`](https://pnpm.io/installation), clone the repository, then run
-
-```shell
-cd niivue-react
-pnpm i
-pnpm test
-```
-
-To set up the example for development, run
-
-```shell
-cd example
-pnpm i
-pnpm link ../niivue-react
-pnpm run dev
-```
-
-## Code Organization
+## Development
 
-- `model.ts`: defines types
-- `diff.ts`: helper functions for doing reconciliation from actual state to desired state.
-  It's analogous to React's internal "diff" algorithm which updates the virtual DOM.
-  Here, we do a diff between objects to compute which mutable setter functions of Niivue to call,
-  which in turn update the canvas. As a programming habit, the functions of `diff.ts` are pure functions.
-- `diff.test.ts`: tests and examples
-- `NiivueCanvas.tsx`: tight coupling between the functions of `diff.ts` to the React library.
+See [DEVELOP.md](./DEVELOP.md)