Definition

A terminal written for cross-platform usge.

Implementation

This project is written in Java using Eclipse IDE for Java EE.

Contributing

View the Contributing Guidelines for more information. The JTerm project is open to anyone and any code!

Builds

Once you build a file from the source code to an archive (.jar), push it to the /build/jar folder, along with the associated changelog (see Changelog section), source code (see Source Code section), and documentation (see Documentation section.) The format of the archive's filename is as follows: "jterm-v(build version).jar"

Source Code

Keep all updated and current source code in the /src directory, which should be updated with every build.
Please review the Source Code Style Guide for more information.
Subfolders are formatted for packaging and for CI integration.
When pushing the source code with a build, DO NOT change the filenames. As mentioned in the "Builds" section, package the source code with every build into a ".zip" file and a Wrapfile that should be placed in the /build/src directory when pushing a build. Subfolders in the /src directory (e.g. /src/main/java/...) should be included in packaged source. Wrapfiles should only include sources in the main/ source directory. The format for the file should be as follows: jterm-src-v(version).zip, and jterm-src-v(version).wrap.

Changelog

Every time an update is pushed, the changelog will be updated and pushed as well. It is highly recommended that every time you build you update the changelog. Once you add something to the changelog, DO NOT remove the entry, unless if, and only if, it is incorrect (such as a typo in the version number.) If you change a previous entry you must include a statement stating your change in a seperate entry. The global changelog file is in the root folder of the project and is named "changelog.txt"; EVERY note will go into this file. It is also required that when you push a build you push an associated changelog file, formatted "jterm-changelog-(build version).txt". This file should be pushed to the /build/changelog directory. Changelog entry headings must be formatted as shown in the given example below. New changelog entries in the global "changelog.txt" file should be placed at the top of the file, not the bottom. Simply create a few newlines before the latest entry and use the newlines to enter the new entry information. Entries must also be tab-indented. The format for a changelog entry is as follows:

(#(entry))[MM/DD/YYYY-HH:MM (version) (username)]   
	(entry contents)   
	(entry contents)  
	(blank newline)  

Here is an example changelog:

(#2)[2/2/2017-3:33 1.3 NCSGeek]     
	information uploaded.   
	added files.   
	pushed to github.   

(#1)[1/1/2017-3:33 1.0 Sergix]
	information uploaded.  
	pushed to github.  

Of course, a real changelog would be more descriptive in its entries.

Timestamps should be in 24-hour (aka military) time.

Versioning

Version numbers should use Semantic Versioning.
Numbering versions on files (such as released builds) should take the format of "vX.Y.Z", where "X.Y.Z" is the version.

Documentation

Documentation is published with every:

• Major and minor release (Documentation Style Guide)
• Patch (Patch Notes Documentation Style Guide)

Slack

The JTerm project now has a Slack messaging group! Request to join the Sergix team to recieve notifications on updates, Travis CI build status, and more on the #jterm channel.

JTerm 0.4.0
jterm-v0.4.0.jar
This project and its source are held under the GNU General Public License, located in the LICENSE file in the project's directory.
(c) 2017