Skip to content

Commit

Permalink
README.md: add build instructions for Fish users
Browse files Browse the repository at this point in the history
  • Loading branch information
stephengold committed Feb 17, 2024
1 parent 98c563a commit 97b0cac
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ Add to the project’s "pom.xml" file:
or "/usr/lib/jvm/java-8-openjdk-amd64/" or
"/Library/Java/JavaVirtualMachines/liberica-jdk-17-full.jdk/Contents/Home" .)
+ using Bash or Zsh: `export JAVA_HOME="` *path to installation* `"`
+ using [Fish]: `set -g JAVA_HOME "` *path to installation* `"`
+ using Windows Command Prompt: `set JAVA_HOME="` *path to installation* `"`
+ using PowerShell: `$env:JAVA_HOME = '` *path to installation* `'`
3. Download and extract the j-ogg-all source code from [GitHub]:
Expand All @@ -171,19 +172,19 @@ Add to the project’s "pom.xml" file:
+ extract the contents of the saved ZIP file
+ `cd` to the extracted directory/folder
4. Run the [Gradle] wrapper:
+ using Bash or PowerShell or Zsh: `./gradlew build`
+ using Bash or Fish or PowerShell or Zsh: `./gradlew build`
+ using Windows Command Prompt: `.\gradlew build`

After a successful build,
Maven artifacts will be found
in "library/build/libs" and "vorbis/build/libs".

You can install the artifacts to your local Maven repository:
+ using Bash or PowerShell or Zsh: `./gradlew install`
+ using Bash or Fish or PowerShell or Zsh: `./gradlew install`
+ using Windows Command Prompt: `.\gradlew install`

You can restore the project to a pristine state:
+ using Bash or PowerShell or Zsh: `./gradlew clean`
+ using Bash or Fish or PowerShell or Zsh: `./gradlew clean`
+ using Windows Command Prompt: `.\gradlew clean`

[Jump to table of contents](#toc)
Expand Down Expand Up @@ -244,6 +245,7 @@ In February 2023, the "library" and "vorbis" subprojects split off.

[adoptium]: https://adoptium.net/releases.html "Adoptium Project"
[daala]: https://xiph.org/daala/ "Daala codec"
[fish]: https://fishshell.com/ "Fish command-line shell"
[flac]: https://xiph.org/flac/ "Free Lossless Audio Codec"
[git]: https://git-scm.com "Git"
[github]: https://github.com "GitHub"
Expand Down

0 comments on commit 97b0cac

Please sign in to comment.