diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ba78d0d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Martin Huber + +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. diff --git a/README.md b/README.md index 634eb91..2adbf21 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# lbr_fri_ros2_stack_doc +# lbr_stack_doc [![Documentation Status](https://readthedocs.org/projects/lbr-fri-ros2-stack-doc/badge/?version=humble)](https://lbr-fri-ros2-stack-doc.readthedocs.io/en/humble/?badge=humble) -This repository holds the documentation for the [lbr_fri_ros2_stack](https://github.com/lbr-stack/lbr_fri_ros2_stack). +This repository holds the documentation for the [lbr-stack](https://github.com/lbr-stack). ## Build Documentation Locally To build locally: 1. Clone this repository ```shell -git clone --recursive git@github.com:lbr-stack/lbr_fri_ros2_stack_doc.git -cd lbr_fri_ros2_stack_doc +git clone --recursive git@github.com:lbr-stack/lbr_stack_doc.git +cd lbr_stack_doc ``` 2. Clone the `lbr_fri_ros2_stack`, e.g. via (this uses [vcs](https://github.com/dirk-thomas/vcstool#how-to-install-vcstool)) @@ -39,6 +39,19 @@ python -m sphinx -T -E -b html -d _build/doctrees -D language=en . html Open and browse the documentation by opening `doc/source/html/index.html`. +## Build Paper Locally +To build the [paper](paper/paper.md) via [Docker](https://joss.readthedocs.io/en/latest/submitting.html#docker), run + +```shell +docker run --rm \ + --volume $PWD/paper:/data \ + --user $(id -u):$(id -g) \ + --env JOURNAL=joss \ + openjournals/inara +``` + +inside the `lbr_stack_doc` repository. + ## Acknowledgements wellcome