From 1e904e35691066c496220674a7450384cb235740 Mon Sep 17 00:00:00 2001 From: Sven Greb Date: Thu, 16 Feb 2023 22:30:24 +0100 Subject: [PATCH] Migrate to the `nordtheme` organization (#14) As part of the "Northern Post - The state and roadmap of Nord" [2] initiative, this repository will be migrated to the `nordtheme` GitHub organization [1]. This included the temporary removal of documentation, since this is outdated by far anyway, and the move to the `nordtheme` organization as a kind of "test subject" in order to ensure that all required metadata and information, e.g. stars and watchers, will be migrated. Note that the documentation will be recreated as part of the data transition [3] later on again, following the new project structure and layout conventions. [1]: https://github.com/nordtheme [2]: https://github.com/arcticicestudio/nord/issues/180 [3]: https://github.com/arcticicestudio/nord-docs/issues/133 GH-13 --- CHANGELOG.md | 57 ++++++++++++++++--- README.md | 126 +++++++++++++++--------------------------- LICENSE.md => license | 3 +- 3 files changed, 95 insertions(+), 91 deletions(-) rename LICENSE.md => license (84%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9e0ea6e..f330510 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,52 +1,93 @@ -

+

+ + + + + + + +

---- - # 0.2.0 (2016-12-03) + ## Improvements + ### Public API + The public API method `getVersion() : String` is now static and returns the `String` constant `VERSION` to adapt to the SonarQube minor rule [squid:S3400](https://sonarqube.com/coding_rules#q=squid%3AS3400). The associated unit test has been refactored to test against the [ArcVer](https://github.com/arcticicestudio/arcver) library [arcver-java](https://github.com/arcticicestudio/arcver). (@arcticicestudio, #8, 7efc44cc) The attribute + ```java private final Color COLOR; ``` + conflicted with the SonarQube rule [squid:S00116](https://sonarqube.com/coding_rules#q=squid%3AS00116) and has been adapted to the Arctic Ice Studio Java code style. (@arcticicestudio, #9, 8eb03e63) ### Toolbox + Fixed the deprecated POM variable `${inceptionYear}` and replaced it with `${project.inceptionYear}`. (@arcticicestudio, #3, 1a02e6d2) Added POM profiles for [JFrog Bintray](https://bintray.com) to deploy Maven artifacts to the [jCenter](https://bintray.com/bintray/jcenter) and snapshots to the [OSS JFrog](https://oss.jfrog.org) repository. (@arcticicestudio, #4, f74c7a57) ### Public API Documentation + Adapted the documentation style of the Nord color palette project to the JavaDoc. (@arcticicestudio, #7, 9eab5800) ## Bug Fixes + ### Public API Documentation + Fixed malformed JavaDoc to prevent compilation errors caused by the new JavaDoc linter rules introduced JDK 8u92 by adding the `summary` attribute to `table` tags. (@arcticicestudio, #3, 1a02e6d2) ## Tasks + ### Toolbox + Created a `circle.yml` configuration file to add [Circle CI](https://circleci.com) build integration. (@arcticicestudio, #6, f241e8de) Added the `maven-assembly-plugin` as `assemble` POM profile (@arcticicestudio, #5, 9f6e438d) # 0.1.0 (2016-09-26) + ## Features + Implemented the public API (@arcticicestudio, #1, 8949a9baa7adf73be66b7ac8e15dfa2b57b0ac92) A basic usage guide for the public API can be found in the [README](https://github.com/arcticicestudio/nord-java/blob/develop/README.md#usage-guide) section. ### API + The entrypoint is the `com.arcticicestudio.nord.Nord` enum. Every enum constant represents a color as `Color` object. The API provides static methods to get the HEX and RGB color code string as well as the `Color` object itself. -| Package | Entity | Modifier | Method | Description | -| ------------ | -------- | ------------ | ----------- | -| `com.arcticicestudio.nord` | `Nord` | static | `+ hex(Color) : String` | Converts the `color` to the HEX identifier. | -| `com.arcticicestudio.nord` | `Nord` | static | `+ rgb(Color) : String` | Converts the `color` to the RGB identifier. | -| `com.arcticicestudio.nord` | `Nord` | - | `+ get() : Color` | Returns the color object. | +| Package | Entity | Modifier | Method | Description | +| -------------------------- | ------ | -------- | ----------------------- | ------------------------------------------- | +| `com.arcticicestudio.nord` | `Nord` | static | `+ hex(Color) : String` | Converts the `color` to the HEX identifier. | +| `com.arcticicestudio.nord` | `Nord` | static | `+ rgb(Color) : String` | Converts the `color` to the RGB identifier. | +| `com.arcticicestudio.nord` | `Nord` | - | `+ get() : Color` | Returns the color object. | + +

+ + + + + +

+ +

+ Copyright © 2016-present Sven Greb +

+ +

+ + + + + + +

diff --git a/README.md b/README.md index 6915a37..5a9bd3f 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,45 @@ -

- -

- -

A arctic, north-bluish color palette Java library.
-Implementation of the Nord project.

- ---- - -## Getting started -### Setup -To use nord-java, it must be available on your classpath. -You can get it from the Central Repository as a dependency for your favorite build tool or [download the latest version](https://github.com/arcticicestudio/nord-java/releases/latest). - - Apache Maven -```xml - - com.arcticicestudio - nord-java - 0.2.0 - -``` - - Gradle -```java -compile(group: 'com.arcticicestudio', name: 'nord-java', version: '0.2.0') -``` - - Apache Ivy -```xml - -``` - -Development snapshots are available via [OSS Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/arcticicestudio/nord-java) and [JFrog Artifactory](https://oss.jfrog.org/webapp/#/artifacts/browse/tree/General/oss-snapshot-local/com/arcticicestudio/nord-java). - -### Build -Build and install nord-java into your local repository without GPG signing: -``` -mvn clean install -``` - -Signed artifacts may be build by using the `sign-gpg` profile with a provided `gpg.keyname` property: -``` -mvn clean install -Dgpg.keyname=YourGPGKeyId -``` - -Continuous integration builds are running at [Travis-CI](https://travis-ci.org/arcticicestudio/nord-java) and [Circle CI](https://circleci.com/bb/arcticicestudio/nord-java). - -## Usage Guide -This is a basic guide to show the common usage of the nord-java API. -The API documentation can be found in the JavaDoc. - -The class `Nord` is the entrypoint to the nord-java API, use it to generate the HEX and RGB color codes. - 1. [Generate color code strings](#generate-color-code-strings) - 2. [Obtaining the Public API version](#obtaining-the-public-api-version) - -### Generate color code strings -Color code strings can be generated from all `Nord` enum constants by using the static methods `hex(Color)` and `rgb(Color)`. -The `Color` object can be obtained from a `Nord` enum variable via the `get()` method. -```java -String hex = Nord.hex(Nord.NORD0.get()); // "#2E3440" -String rgb = Nord.rgb(Nord.NORD8.get()); // "rgb(136, 192, 208)" -``` - -### Obtaining the Public API version -The `getVersion()` method returns the [ArcVer](https://github.com/arcticicestudio/arcver) version of the public API. -```java -String version = Nord.getVersion(); // "0.2.0" -``` - -## Development -[![](https://img.shields.io/badge/Changelog-0.2.0-blue.svg)](https://github.com/arcticicestudio/nord-java/blob/v0.2.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow_Branching_Model-blue.svg)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-blue.svg)](https://github.com/arcticicestudio/arcver) - -### Contribution -Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-java/issues). - -

- -

Copyright © 2016-present Arctic Ice Studio

- -

+

+ + + + + + + +

+ +

+ + + + + + +

+ +

+ Official Java implementation of Nord — An arctic, north-bluish color palette. +

+ +This repository is currently in a transitioning phase and work in progress! + +

+ + + + + +

+ +

+ Copyright © 2016-present Sven Greb +

+ +

+ + + + + + +

diff --git a/LICENSE.md b/license similarity index 84% rename from LICENSE.md rename to license index 34bd797..996f8fb 100644 --- a/LICENSE.md +++ b/license @@ -1,7 +1,6 @@ MIT License (MIT) -Copyright (c) 2016-present Arctic Ice Studio (http://arcticicestudio.com) -Copyright (c) 2016-present Sven Greb (http://svengreb.de) +Copyright (c) 2016-present Sven Greb (https://www.svengreb.de) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal