Commit 2982e981 authored by Noe Nieto's avatar Noe Nieto 💬
Browse files

Merge branch 'master' of source.puri.sm:liberty/ldh_developer

parents 4e70d0a4 1d00f176
......@@ -2,15 +2,70 @@
[project] | [code] | [tracker] | [wiki]
*Shipwright* is a toolkit for developers assembling a Liberty Deckplan Host
(LDH). These tools are not suitable for production use.
*Shipwright* is a toolkit for developers assembling a Liberty Deckplan
Host (LDH). These tools are not suitable for production use.
## Install from source
Shipwright tools are intended to be run from source via the
`shipwright` command, which can be installed as follows:
```
git clone https://source.puri.sm/liberty/ldh_developer.git
cd ldh_developer
./bootstrap
```
You should now be able to call `shipwright` from the command prompt.
If not, see **Troubleshooting**.
## Instructions
Each tool is contained in a folder. Instructions for each tool are found in
a `README.md` file in that folder.
Each Shipwright tool is contained in a subfolder. Instructions for
each tool are found in a `README.md` file in that folder.
Instructions for other tools are found on the Shipwright [wiki].
## Creating a new tool
Every new tool should be made up of:
* its own folder, including a `README.md` file
* at least one entry in the `bin` folder
## Troubleshooting
If you can't call `shipwright` from the command line, follow these
steps and report a bug at the step that you encounter a failure.
1. Check that the file `~/.local/bin/shipwright` exists. It should be
a working symlink to `ldh_developer/shipwright` in the folder where
you cloned the Git repository. If you have moved that folder,
simply run `./bootstrap` again to recreate the symlink.
2. Check your $PATH. If you invoke `echo $PATH` the result should
include `~/.local/bin` (in expanded form). If it doesn't...
3. Restart your session, it may not have existed at the beginning of
your sesssion. If it still doesn't appear...
4. Check `~/.profile`, add a clause like the one below, and restart
your session...
# set PATH so it includes user's private bin if it exists
if [ -d "$HOME/.local/bin" ] ; then
PATH="$HOME/.local/bin:$PATH"
fi
5. If you still can't call `shipwright`, make a note of your distro
version and shell version and report an upstream query, asking
how to add `~/.local/bin/` to your $PATH. If upstream cannot help,
create an issue in the Shipwright [tracker] and reference the
upstream query.
Instructions for other tools are found in the project [wiki]
If you can call `shipwright` from the command line and encounter a
problem while doing so, please create an issue in the Shipwright
[tracker].
## Sharing and contributions
......
#! /bin/sh
exec $HOME/.local/ldh_developer/shipyard/shipyard "$@"
#!/bin/sh
mkdir --parents $HOME/.local/bin
rm --recursive --force $HOME/.local/ldh_developer
rm --force $HOME/.local/bin/shipwright
ln --symbolic --force $PWD $HOME/.local/ldh_developer
ln --symbolic --force $PWD/shipwright $HOME/.local/bin/shipwright
#! /bin/sh
exec $HOME/.local/ldh_developer/bin/"$@"
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