readme, bugfix and reuse compliancy

Author: al1-ce

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Device info**
+- OS: [e.g. Arch Linux x64 or Windows x86]
+- Faux version: [e.g. v1.0.0]
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.
+
+**Minimal reproduction project**
+Most simple project that will allow to reproduce this bug

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/d.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+name: D
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: dlang-community/setup-dlang@4c99aa991ce7d19dd3064de0a4f2f6b2f152e2d7
+
+    - name: 'Build & Test'
+      run: |
+        # Build the project, with its main file included, without unittests
+        dub build --compiler=$DC
+        # Build and run tests, as defined by `unittest` configuration
+        # In this mode, `mainSourceFile` is excluded and `version (unittest)` are included
+        # See https://dub.pm/package-format-json.html#configurations
+        dub test --compiler=$DC
+

.github/workflows/reuse.yml

@@ -0,0 +1,11 @@
+name: REUSE Compliance Check
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: REUSE Compliance Check
+      uses: fsfe/reuse-action@v3

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+-   repo: https://github.com/fsfe/reuse-tool
+    rev: v1.0.0
+    hooks:
+    - id: reuse
+

.reuse/dep5

@@ -0,0 +1,17 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: sily
+Upstream-Contact: Alisa Lain <[email protected]>
+Source: https://github.com/al1-ce/sily
+
+Files: test/* readme/*
+Copyright: (C) 2022 Alisa Lain <[email protected]>
+License: GPL-3.0-or-later
+
+Files: .github/* dub.sdl .dub/* .gitignore .pre-commit-config.yaml
+Copyright: (C) 2022 Alisa Lain <[email protected]>
+License: CC0-1.0
+
+Files: .todo.md AUTHORS.md CHANGEDLOG.md CONTRIBUTING.md README.md justfile
+Copyright: (C) 2022 Alisa Lain <[email protected]>
+License: CC0-1.0
+

AUTHORS.md

@@ -0,0 +1,2 @@
+[Alisa Lain aka al1-ce / silyneko](https://github.com/al1-ce)
+

CONTRIBUTING.md

@@ -0,0 +1,150 @@
+# Contributing Guidelines
+
+#### Bug reporting 
+
+Open an issue at [GitHub issue tracker](https://github.com/al1-ce/sily/issues). Before doing that, ensure the bug was not already reported or fixed in `master` branch. Describe a problem and, if necessary, provide minimal code needed to reproduce it.
+
+#### Bug fixing 
+
+Open a new GitHub pull request with your patch. Provide a description of the problem and solution. Follow our [code style](#code-style-and-standards).
+
+#### Implementing new features
+
+New code should at least:
+* work under Windows and POSIX systems and provide platform-agnostic API
+* support x86 and x86_64 targets
+* not use any external dependencies or have them as optional dependencies
+* follow our [code style](#code-style-and-standards)
+* not violate copyright/licensing. When adapting third-party code, make sure that it is compatible with [GNU GPL 3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).
+
+#### Branching strategy
+
+`master` branch is a development branch for the next release. When release is ready, `master` branch will be pushed into `release` branch and release will be made from it.
+
+#### Code style and standards 
+
+Sily mostly follows [D style](https://dlang.org/dstyle.html). Essential rules are the following:
+* Use spaces instead of tabs. Each indentation level is 4 spaces
+* There's always a space after control statements (`if`, `while`, `for`, etc...)
+* Opening curly bracket should be on a **same** line
+* Functions and variables should be in `camelCase`
+* Classes, structs and enums should be in `PascalCase`
+* Module names should be in lowercase
+* `if () else if ()` can be split as `if () else\n if ()`
+* If method or function is used as property parenthesis can be dropped
+* Prefer explicitly importing methods instead of importing whole module when only several methods from this module are needed. Exception is when imported module declares only one thing (i.e vector and aliases for it)
+* Also prefer explicitly importing sub-modules. I.e `import std.algorithm.searching;` instead of `import std.algorithm;`
+* Imports are ordered separated by single space. First normal, then static and finally public:
+    1. std
+    2. core
+    3. other libraries (with version specifier)
+    4. sily
+* Preferred order of declarations for classes or structs is:
+    1. Public properties and one-line setters/getters
+    2. Private properties
+    3. Constructors
+    4. Public methods
+    5. Private methods
+* Name prefixes are:
+    - ` ` - none for any kind of properties except ones below (`public static const int normalProperty`)
+    - `_` - for private/protected properties (`private int _privateProperty`)
+    - `s_` - for private/protected static properties (`private static int s_staticInt`)
+    - `t_` - for private/protected thread static properties (`private shared int t_staticInt`)
+    - `_` - as postfix when name is a keyword (`bool bool_`)
+* Function signature preferred to be in order:
+    1. attributes (@property)
+    2. visibility (public, private...), `public` can be dropped since everything is default public
+    3. isStatic (static)
+    4. misc
+    5. isOverride (override)
+    6. type qualifiers and type (int, bool...)
+    7. name and params
+    8. attributes (const, nothrow, pure, @nogc, @safe)
+    9. i.e `@property private static override int myMethod(int* ptr) @safe @nogc nothrow {}`
+* Interfaces must be prefixed with `I`, i.e. `IEntity`
+* When declaring properties, methods, etc... visibility modifier can be dropped in favor of global visibility modifier, i.e `private:`. This type of declaration is valid but should be avoided since it's considered implicit
+    - Example:
+    ```
+    class MyClass {
+        public:
+        int myPublicInt;
+        string myPublicString;
+        
+        private:
+        int myPrivateInt;
+
+        public:
+        int myPublicIntMethod() {}
+        ...
+    }
+    ```
+* Always describe symbols with ddoc unless name is self-descriptive (for properties)
+* **Avoid exceptions at all costs.** Prefer status return checks and if needed to return nullable
+* Include copyright line at top of source file or in `.reuse/dep5` for resource files or meta files
+* Copyright line is subject to change!
+
+Example of how a module would look like when adhering to those rules:
+```d
+// SPDX-FileCopyrightText: (C) 2022 Alisa Lain <[email protected]>
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+/++
+Custom sily module.
+Currently an example of style to use in sily source code.
++/
+module sily.custom;
+
+import std.stdio: stdout, stdin, writeln;
+
+import core.stdc: FILE;
+
+version (Have_clib) import clib.optional;
+
+import sily.vector;
+import sily.term: isatty;
+
+static import sily.tui;
+
+public import sily.web;
+
+/// Prints if std is a tty
+void funcName() {
+    if (stdout.isatty) {
+        trace("STDOUT is a tty");
+    } else
+    if (stdin.isatty) {
+        trace("STDIN is a tty");
+    } else {
+        trace("None are tty")
+    }
+}
+
+/// CustomStruct isCustom type enum
+enum CustomEnum {
+    enumKey1,
+    enumKey2
+}
+
+/// Structure to do custom things
+struct CustomStruct {
+    /// Is custom struct
+    CustomEnum isCustom;
+    /// Struct index
+    static int index;
+    
+    private int _privateIndex;
+    private shared bool t_isInit;
+    
+    /// Returns private name
+    @property string getName() const {
+        return privateName();
+    }
+
+    /// Ditto
+    private string privateName() const {
+        return "my private name";
+    }
+}
+```
+
+

LICENSES/CC0-1.0.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.