Skip to content

Jaxon 1.0.1 - Remote Template Packages

Latest
Latest
Compare
Choose a tag to compare
@Konloch Konloch released this 30 Jul 23:34
· 66 commits to master since this release
v1.0.1
a44cafb

Jaxon v1.0.1

  • We've introduced a significant change in how we deliver templates. Previously, they were bundled with the binary, but now we maintain a package.list file that contains versioning information. When configuring templates for the first time, you can optionally specify a version. If you don't, the latest version will be downloaded automatically by comparing semantic versions.
  • CLI bug fixes are also included in this release.

Jaxon Quick Start Guide

  • First start by downloading Jaxon for your platform
    • Run the command jaxon install
      • If you're not on windows you'll have to add Jaxon to your System-Path manually
  • Then start by creating a new project, this is done through code templates. (such as jaxon template console)
    • Console - Cross-platform minified template for printing to console.
      • Note This template contains the in-development runtime library.
  • After you have created a template using Jaxon:
    • Use the build scripts to build binaries.
    • At some point you're going to want to get Intellij working.
      • If you've already ran jaxon install
        • Your JDK will be in {user}/.jaxon/JDK
      • If you haven't done that, just run the following command
        • jaxon jdk jdk-1.8
      • Then set the JDK folder as the SDK in Intellij:
        • F4 for Module Settings
        • Project > SDK > Edit
        • Click the Plus > Add JDK...
        • Paste in the path sent from the Jaxon CLI

Jaxon Upgrade Guide

Using Jaxon Templates

  • The templates all contain the basics to get you running (Console shows hello world, Graphical shows windowing & image drawing)
  • Each template can contain a different application starting class
    • You can find this class by going into Windows/kernel/Kernel.java & Linux/kernel/Kernel.java
  • The templates contain the entire standard library, edit these as much as you want
    • One benefit is you are not restricted by the concept of precompiled libraries, you are always provided the source unless you are invoking a DLL

Jaxon Templates

  • Note To use these templates use jaxon template [name] such as jaxon template console
  • Console - Cross-platform template for printing to console.
    • Note This template contains the latest in-development runtime library.
    • This version is considered the most 'cutting edge' and will contain the most complete runtime library.
  • Graphical - Cross-platform template for windowed graphical applications.
    • This contains an early proof of concept for shared windowing between Linux and Windows.
    • The runtime is outdated and is planned to be updated with a windowing API.
  • Barebones - Cross-platform minified template for printing to console.
    • This is added if you want to roll your own runtime library.
    • This lacks the entire Runtime and only contains the bare template to compile.
  • ATmega - ARM7 ATmega embedded controller template.
    • Note This template is currently having build issues.
  • Operating-System - 32bit / 64bit template for operating system.
    • This runtime is also outdated is planned for a runtime update.
  • Operating-System-Hello-World - 32bit / 64bit operating system hello world.
    • A minified operating system runtime with nothing more than a video buffer.

Jaxon Command Line

  • template - Create a new template in the current directory
    • Available Templates: (Console, Graphical, ATmega, Operating-System)
    • Example Command: jaxon template console
  • build - Build using a specific profile
    • Available Profiles: (win-exe, win-app, lin, atmega, os-32, os-64)
    • Example Command: jaxon build win-exe src/shared/src src/windows/src
  • install - Install Jaxon to the computer
    • Example Command: jaxon install
    • Copy the Jaxon binary into {user}/.jaxon/binaries
    • Add Jaxon to the System-Path
    • Copy the Jaxon JDK into {user}/.jaxon/JDK
  • uninstall - Uninstall Jaxon from the computer
    • Delete the {user}/.jaxon folder
    • Remove all traces of Jaxon from the System-Path
  • jdk - Create a Jaxon-Blank-SDK that will resolve all issues with Jaxon template projects.
    • Example Command: jaxon jdk jdk-1.8
    • Load the SDK Into Intellij:
      • F4 for Module Settings
        • Project > SDK > Edit
        • Click the Plus > Add JDK...
        • Paste in the path sent from the Jaxon CLI
  • system-path - Manage the system path by adding or removing jaxon to it.
    • Add Jaxon to System-Path: jaxon system-path add
    • Remove Jaxon from System-Path: jaxon system-path remove
  • sjc - Access underlying SJC command-line
  • zip - Zip util for packaging Jaxon templates

Full Changelog: https://github.com/Konloch/Jaxon/commits/v1.0.1

Assets 5
Loading