truenotzero / smart_config

An easy-to-use configuration file library, for Java 8

Smart Config

An easy-to-use library for configuration files

WIP

Still not done, hold onto your butts

smart_config's Issues

Tests

Before releasing this library, I split it into an API and a default implementation.
I haven't had enough time to fix the tests.

To Do:

• Separate the tests: At the moment the test file contains both API and implementation tests
• Make sure that API tests are relevant
• Add any necessary implementation tests

Swank up README.md

Right now, README.md is barebones and just plain boring to stare at, even though the API and the implementation are fantastically well documented.

I'd like to have an easy-to-understand README.md that describes the use case of the library with some code examples as well as relevant links to files for further reading.

Add license to all files

Right now, none of the files contain a license notice, instead there's a LICENSE file.
To all possible contributors; please add a license clause to all files you might work on, before the package declaration.
An example is provided:

/*
 * Copyright 2019 truenotzero
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package truenotzero.smart_config;

// ...

Do not go out of your way to add licensing to all files. Merely, if you spot a file without a license notice while working on it, be sure to add it.