### Build and Run All Examples

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/examples/README.md

Build all examples and run the application launcher. Ensure data files are checked out.

```bash
cd boofcv/examples
gradle examples
java -jar examples.jar
```

--------------------------------

### Build and Run BoofCV Examples

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/README.md

Commands to clean stale files, autogenerate code, build the examples JAR, and run the examples. Requires Java 11 or newer.

```bash
cd boofcv
git clean -fd main
./gradlew autogenerate
./gradlew examplesJar
java -jar examples/examples.jar
```

--------------------------------

### Run Specific Example

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/examples/README.md

Run a specific example class outside the application launcher. Requires the examples.jar to be built.

```bash
java -cp examples.jar boofcv.examples.imageprocessing.ExampleBinaryOps
```

--------------------------------

### Build BoofCV from Source with Gradle

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/README.md

Commands to build BoofCV from source. This includes cleaning stale files, generating necessary code, and installing the library into the local Maven repository.

```bash
cd boofcv
git clean -fd main                # Removes stale autogenerated code
./gradlew autogenerate            # Creates auto generated files
./gradlew publishToMavenLocal     # Installs it into the local maven repository 
```

--------------------------------

### Build and Run BoofCV Demonstrations

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/README.md

Commands to build the demonstrations JAR and run the demonstrations application. Requires Java 11 or newer.

```bash
cd boofcv
./gradlew demonstrationsJar
java -jar demonstrations/demonstrations.jar
```

--------------------------------

### Build and Run BoofCV Applications

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/applications/readme.md

Build the applications JAR and then execute it to see available command-line tools. Ensure you are in the 'boofcv' directory.

```bash
cd boofcv
./gradlew applicationsJar
java -jar applications/applications.jar
```

```bash
Trying to run a command-line application?  Here are your options!

  CreateFiducialSquareImage
  CreateFiducialSquareBinary
  CreateFiducialRandomDot
...
```

--------------------------------

### Initialize Git Submodules

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/README.md

After cloning, navigate to the boofcv directory and initialize all git submodules. This is crucial if the initial clone was not recursive.

```bash
cd boofcv
git submodule update --init --recursive
```

--------------------------------

### Upload Release Artifacts to SourceForge

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/misc/release_check_list.txt

Securely copies the generated library and source zip files to the SourceForge project directory. Replace 'pabeles' and the version number as appropriate.

```bash
scp boofcv-$VERSION-libs.zip pabeles@frs.sourceforge.net:/home/frs/project/boofcv/$VERSION/
scp boofcv-$VERSION-src.zip pabeles@frs.sourceforge.net:/home/frs/project/boofcv/$VERSION/
```

--------------------------------

### Build BoofCV Libraries

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/misc/release_check_list.txt

Creates the library directory and packages the compiled libraries into a zip archive. This is a necessary step before uploading the libraries.

```bash
cd boofcv && ./gradlew createLibraryDirectory && mv boofcv-*-libs .. && cd .. && zip -r boofcv-$VERSION-libs.zip boofcv-$VERSION-libs
```

--------------------------------

### Generate and Package Javadoc

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/misc/release_check_list.txt

Generates the web-ready Javadoc documentation and packages it into a zip file for upload. Ensure the 'docs/api-web' directory is clean before generation.

```bash
cd boofcv && rm -rf docs/api-web && ./gradlew alljavadocWeb && zip -r api.zip docs/api-web
```

--------------------------------

### Build BoofCV Utility Jars with Gradle

Source: https://github.com/lessthanoptimal/boofcv/blob/SNAPSHOT/README.md

Gradle commands to create utility JARs from the BoofCV source. Options include building a single fat JAR, organizing all dependencies into a library directory, and generating combined JavaDocs.

```bash
./gradlew oneJarBin               # Builds a single jar with all of BoofCV in it
./gradlew createLibraryDirectory  # Puts all jars and dependencies into boofcv/library
./gradlew alljavadoc              # Combines all JavaDoc from all sub-projects into a single set
```