Commit 852c93e3 authored by David Seaward's avatar David Seaward
Browse files

change name, add full texts for licence, origin and code of conduct


Signed-off-by: David Seaward's avatarDavid Seaward <david.seaward@puri.sm>
parent ab96d085
# Shipwright
*Shipwright* is a command-line tool for operating one or more Purist
Services Host (PSH) installations from your local session.
[project] | [code] | [tracker]
*Shipwright* is a command-line tool for operating one or more Liberty
Sailplan Hosts (LSHs) from your local session. The reference
implementation for an LSH operator toolkit.
## Installation
The preferred way to install Shipwright is with your package manager.
The recommended package name is `psh_operator`. For example:
The recommended package name is `lsh_operator`. For example:
sudo apt install psh_operator # Debian-based (doesn't exist yet)
sudo apt install lsh_operator # Debian-based (doesn't exist yet)
or
pipsi install psh_operator # Python-based (doesn't exist yet)
pipsi install lsh_operator # Python-based (doesn't exist yet)
## Usage
......@@ -29,27 +32,45 @@ If you'd prefer to run from source...
2. Get source:
git clone https://source.puri.sm/purist/psh_operator.git
git clone https://source.puri.sm/liberty/lsh_operator.git
3. Install with pipenv:
cd /path/to/psh_operator
cd lsh_operator
pipenv install
## Usage (from source)
```bash
cd /path/to/psh_operator
cd lsh_operator
pipenv run shipwright --help
```
## Sharing and contributions
Shipwright
<https://source.puri.sm/purist/psh_operator>
Shipwright (LSH operator)
<https://source.puri.sm/liberty/lsh_operator>
Copyright 2018 Purism SPC
SPDX-License-Identifier: AGPL-3.0-or-later
Shared under AGPL-3.0-or-later. We adhere to the Contributor Covenant
1.4 without modification, and certify origin per DCO 1.1 with a
Shared under AGPL-3.0-or-later. We adhere to the Community Covenant
1.0 without modification, and certify origin per DCO 1.1 with a
signed-off-by line. Contributions under the same terms are welcome.
For details see:
* [COPYING.AGPL.md], full license text
* [CODE_OF_CONDUCT.md], full conduct text
* [CONTRIBUTING.DCO.md], full origin text
<!-- Links -->
[project]: https://source.puri.sm/liberty/lsh_operator
[code]: https://source.puri.sm/liberty/lsh_operator/tree/master
[tracker]: https://source.puri.sm/liberty/lsh_operator/issues
[SETUP.md]: SETUP.md
[COPYING.AGPL.md]: COPYING.AGPL.md
[CODE_OF_CONDUCT.md]: CODE_OF_CONDUCT.md
[CONTRIBUTING.DCO.md]: CONTRIBUTING.DCO.md
[COPYING.md]: COPYING.md
[CONTRIBUTING.md]: CONTRIBUTING.md
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment