d2/ci/release/template/README.md.sh

#!/bin/sh
set -eu

cat <<EOF
# d2

For docs, more installation options and the source code see https://oss.terrastruct.com/d2

version: $VERSION

## Install

\`\`\`sh
make install DRY_RUN=1
# If it looks right, run:
# make install
\`\`\`

Pass \`PREFIX=somepath\` to change the installation prefix from the default which is
\`/usr/local\` or \`~/.local\` if \`/usr/local\` is not writable with the current user.

## Uninstall

\`\`\`sh
make uninstall DRY_RUN=1
# If it looks right, run:
# make uninstall
\`\`\`
EOF
ci/release: Checkpoint 2022-11-11 09:17:06 +00:00			`#!/bin/sh`
			`set -eu`

			`cat <<EOF`
			`# d2`

2022-11-12 02:19:09pm 2022-11-12 22:19:09 +00:00			`For docs, more installation options and the source code see https://oss.terrastruct.com/d2`

ci/release: Checkpoint 2022-11-11 09:17:06 +00:00			`version: $VERSION`

			`## Install`

2022-11-12 02:19:09pm 2022-11-12 22:19:09 +00:00			\`\`\`sh
ci/release: Use release.sh script in ci/sub 2022-11-14 13:37:11 +00:00			`make install DRY_RUN=1`
2022-11-12 02:19:09pm 2022-11-12 22:19:09 +00:00			`# If it looks right, run:`
install.sh: Improve default $PREFIX behaviour As before we default to /usr/local but now we switch to ~/.local if /usr/local if not accessible instead of prompting for sudo. Instead of having an exception for macOS/arm64. Of course if a user wants to install in /usr/local anyway, they can still pass --prefix /usr/local to force installation into /usr/local and prompt for sudo. 2022-12-06 05:51:46 +00:00			`# make install`
2022-11-12 02:19:09pm 2022-11-12 22:19:09 +00:00			\`\`\`

install.sh: Improve default $PREFIX behaviour As before we default to /usr/local but now we switch to ~/.local if /usr/local if not accessible instead of prompting for sudo. Instead of having an exception for macOS/arm64. Of course if a user wants to install in /usr/local anyway, they can still pass --prefix /usr/local to force installation into /usr/local and prompt for sudo. 2022-12-06 05:51:46 +00:00			Pass \`PREFIX=somepath\` to change the installation prefix from the default which is
			\`/usr/local\` or \`~/.local\` if \`/usr/local\` is not writable with the current user.
ci/release: Use release.sh script in ci/sub 2022-11-14 13:37:11 +00:00
2022-11-12 02:19:09pm 2022-11-12 22:19:09 +00:00			`## Uninstall`

			\`\`\`sh
ci/release: Use release.sh script in ci/sub 2022-11-14 13:37:11 +00:00			`make uninstall DRY_RUN=1`
2022-11-12 02:19:09pm 2022-11-12 22:19:09 +00:00			`# If it looks right, run:`
install.sh: Improve default $PREFIX behaviour As before we default to /usr/local but now we switch to ~/.local if /usr/local if not accessible instead of prompting for sudo. Instead of having an exception for macOS/arm64. Of course if a user wants to install in /usr/local anyway, they can still pass --prefix /usr/local to force installation into /usr/local and prompt for sudo. 2022-12-06 05:51:46 +00:00			`# make uninstall`
2022-11-12 02:19:09pm 2022-11-12 22:19:09 +00:00			\`\`\`
ci/release: Checkpoint 2022-11-11 09:17:06 +00:00			`EOF`