Use LICENSE and README.md symlinks from skore to skore/skore

.github/workflows/release.yml

@@ -45,9 +45,11 @@ jobs:
 
       - name: Build package distributions
         run: |
-          python -m pip install build
-
+          cp --remove-destination LICENSE skore/LICENSE
+          cp --remove-destination README.md skore/README.md
           cd skore
+
+          python -m pip install build
           python -m build
 
       - name: Checks whether distribution’s long description will render correctly on PyPI

.github/workflows/skore.yml

@@ -59,6 +59,9 @@ jobs:
           pre-commit run --all-files ruff
 
           # Build
+          cp --remove-destination ../LICENSE ./LICENSE
+          cp --remove-destination ../README.md ./README.md
+
           python -m build
 
           # Install

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Probabl
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

README.md

@@ -0,0 +1,79 @@
+# skore
+
+![lint](https://github.com/probabl-ai/skore/actions/workflows/lint.yml/badge.svg)
+![tests](https://github.com/probabl-ai/skore/actions/workflows/backend.yml/badge.svg)
+![UI tests](https://github.com/probabl-ai/skore/actions/workflows/skore-ui.yml/badge.svg)
+
+## Installation
+
+For now, the only supported method to use skore is from source.
+Follow the instructions in [CONTRIBUTING.md](/CONTRIBUTING.md#quick-start) to install dependencies and start the UI.
+
+## Quick start
+
+For a complete introductory example, see our [basic usage notebook](/examples/basic_usage.ipynb). The resulting skore report has been exported to [this HTML file](https://gist.github.com/augustebaum/6b21dbd7f7d5a584fbf2c1956692574e): download it and open it in your browser to visualize it.
+
+In your shell, run the following to create a project file `project.skore` (the default) in your current working directory:
+```sh
+python -m skore create
+```
+
+Run the following in your Python code to load the project:
+```python
+from skore import load
+
+project = load("project.skore")
+```
+
+You can save items you need to track in your project:
+```python
+project.put("my int", 3)
+```
+
+You can also get them back:
+```python
+project.get("my int")
+```
+
+By default, strings are assumed to be Markdown:
+```python
+project.put("my string", "Hello world!")
+```
+
+Note that `put` overwrites previous data
+```python
+project.put("my string", "Hello again!")
+```
+
+You can list all the keys in a project with:
+```python
+project.list_keys()
+```
+
+You can delete items with:
+```python
+project.delete_item("my int")
+```
+
+Then, in the directory containing your project, run the following command to start the UI locally:
+```sh
+python -m skore launch project.skore
+```
+
+This will automatically open a browser at the UI's location.
+
+
+## Roadmap
+
+With Skore, you can:
+- Store data
+- Visualize data
+
+In the future, you will be able to:
+- Share visualizations of your data
+- Extract insights from your data
+- Get tips on how to improve your data science code
+
+## Contributing
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md) for more information and to contribute to the evolution of this library.