Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
XyperCode committed Nov 10, 2023
2 parents f35a908 + 94f7326 commit 7a57121
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 4 deletions.
33 changes: 33 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Use the latest 2.1 version of CircleCI pipeline process engine.
# See: https://circleci.com/docs/2.0/configuration-reference
version: 2.1

# Define a job to be invoked later in a workflow.
# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
jobs:
build:
# Specify the execution environment. You can specify an image from Dockerhub, or use one of our Convenience Images from CircleCI's Developer Hub.
# See: https://circleci.com/docs/2.0/configuration-reference/#docker-machine-macos-windows-executor
docker:
- image: gradle:jdk17
description: "Build Linux DEB package"
# Add steps to the job
# See: https://circleci.com/docs/2.0/configuration-reference/#steps
steps:
- checkout
- run:
name: "Make gradlew executable"
command: "chmod +x gradlew"
- run:
name: "Build Project"
command: |
./gradlew clean build
environment:
CIRCLE_CI: "true"

# Invoke jobs via workflows
# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
workflows:
build-workflow:
jobs:
- build
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Ultreon Binary Object
**File Extension:** `.ubo`
**API Language:** `Java 17`
**API Language:** `Java 8`

## Usage
Assuming you use gradle.
1. In `build.gradle`, define the repository as follows:
```gradle
repositories {
// ...
maven { url 'https://jitpack.io' }
maven { url "https://github.com/Ultreon/ultreon-data/raw/main/.mvnrepo/" }
}
```
2. Then, in `build.gradle`, define the dependency:
```gradle
dependencies {
implementation 'com.github.Ultreon:ultreon-data:0.1.0'
implementation 'io.github.ultreon:ubo:1.2.1+patch.1'
}
```
3. We can now proceed to the using section. The `DataIo` class is capable of reading and writing UBO data.
Expand All @@ -35,4 +35,5 @@ Assuming you use gradle.
```
4. You can now build it. You can change the example in step 3 to suit your needs.

Here's the [jitpack listing](https://jitpack.io/#Ultreon/ultreon-data) for the current versions and builds you can use.
~~Here's the [jitpack listing](https://jitpack.io/#Ultreon/ultreon-data) for the current versions and builds you can use.~~ (Temporarily not used)
Check out the releases page for latest releases.

0 comments on commit 7a57121

Please sign in to comment.