Skip to content

Commit

Permalink
docs: Fern installation instructions for script
Browse files Browse the repository at this point in the history
  • Loading branch information
AngelOnFira committed Apr 11, 2024
1 parent be4abfb commit d7962d1
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions scripts/fern/gen_inner.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
#!/usr/bin/env bash
set -euf -o pipefail

# To install fern, first clone the repo and check out the branch
# $ git clone https://github.com/rivet-gg/fern
# $ cd fern
# $ git checkout max/remove-headers
#
# Then, follow the instructions in SETUP.md and CONTRIBUTING.md to compile fern
# $ yarn
# $ yarn compile
# $ yarn dist:cli:dev
#
# Finally, run this with the path to the fern repo, say:
# $ FERN_REPO_PATH=~/fern ./oss/scripts/fern/gen.sh

set +u
if [ -z "$FERN_REPO_PATH" ]; then
echo 'Please clone and build https://github.com/rivet-gg/fern/tree/max/remove-headers and set $FERN_REPO_PATH. This is a workaround until https://github.com/fern-api/fern/pull/2551 is resolved.'
Expand Down

0 comments on commit d7962d1

Please sign in to comment.