Giter VIP home page Giter VIP logo

tsubakuro's Introduction

Requirements for and how to build Tsubakuro

Requirements

JDK

Dependency packages for Native Library

Tsubakuro needs to install several packages for Native Libarary builds. See Dockerfile section.

Dockerfile

FROM ubuntu:22.04

RUN apt update -y && apt install -y git build-essential cmake libboost-system-dev openjdk-11-jdk

How to build

full build

Build java libraries(jar) and native shared libraries(so).

cd ${ProjectTopDirectory}
./gradlew build

where ${ProjectTopDirectory} is a directory created by clone of the tsubakuro repository in git (https://github.com/project-tsurugi/tsubakuro).

build only java libraries

Build only java libraries and skip testing and building native libraries.

./gradlew assemble -PskipBuildNative

install

Build and deploy the java and native libraries into Maven Local Repository.

./gradlew PublishToMavenLocal

install only java libraries

Build and deploy only the java libraries into Maven Local Repository.

./gradlew PublishMavenJavaPublicationToMavenLocal -PskipBuildNative

generate all(aggregated) Javadoc

Generate Javadoc for whole Tsubakuro classes in directory ${ProjectTopDirectory}/build/docs/javadoc-all.

cd ${ProjectTopDirectory}
./gradlew allJavadoc

Generated in directory ${ProjectTopDirectory}/build/docs/javadoc-all

generate Javadoc for client API

Generate Javadoc for Tsubakuro client API in directory ${ProjectTopDirectory}/build/docs/javadoc-client-api.

cd ${ProjectTopDirectory}
./gradlew clientApiJavadoc

How to use

Setup dependencies

To use on Gradle, add Tsubakuro libraries and SLF4J implementation library to dependencies.

dependencies {
    implementation 'com.tsurugidb.tsubakuro:tsubakuro-session:1.0.0'
    implementation 'com.tsurugidb.tsubakuro:tsubakuro-connector:1.0.0'

    implementation 'org.slf4j:slf4j-simple:1.7.32'
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.