commit 039616ce0bc89c6ee3bf968e32d2a707ed942c86
parent ac3e634f7644765213cc242dfad9e765b223cedf
Author: Mario Rosell R. Martinez <mario@mariorosell.es>
Date: Fri, 3 Apr 2026 21:07:26 +0200
doc: documenttion
Diffstat:
| A | .mailmap | | | 6 | ++++++ |
| A | CONTRIBUTORS | | | 13 | +++++++++++++ |
| A | HACKING | | | 63 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | LICENSE | | | 122 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | README | | | 14 | ++++++++++++++ |
5 files changed, 218 insertions(+), 0 deletions(-)
diff --git a/.mailmap b/.mailmap
@@ -0,0 +1,6 @@
+#
+# maiilmap -- mail information for mantainers
+#
+
+Mario Rosell <mario@maiorosell.es> Mario Rosell R. Martinez <mario@mariorosell.es>
+
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -0,0 +1,13 @@
+ ****************
+ * CONTRIBUTORS *
+ ****************
+
+This is a list of everyone that has contributed to the Slash project. The list
+is written in the format of:
+
+* My Name <email> [Active|Inactive] - Stuff I did/do
+
+-------------------------------------------------------------------------------
+
+* Mario Rosell <mario at mariorosell dot es> [Active] - Main mantainer.
+
diff --git a/HACKING b/HACKING
@@ -0,0 +1,63 @@
+ ****************
+ * CONTRIBUTING *
+ ****************
+
+Thanks for your interest in contributing! Here a few rules and stuff to keep
+the project consistent and (relatively) easy to mantain.
+
+SETUP
+=====
+
+1. Clone the project
+2. Make a new branch:
+ ~~~
+ git checkout -b ft/feature-name
+ ~~~
+3. Do your changes
+4. Send patches
+
+SOURCE
+======
+
+Project is written in POSIX-compliant (non-GNU) C99, and Slash itself. If
+justified, it can be ok to add a new language. Languages that are NOT gonna be
+merged:
+
+ * C++
+ * C#
+ * Rust
+ * Zig
+ * Underdocumented dialects of languages
+
+CONVENTIONS
+===========
+
+You shall use hard tabs, equivalent to eight characters. You also must limit
+your column count to 80 characters HARD, although messages must not be cut out,
+as that would make them impossible to grep for. A function implementation's
+type must be in the line before the name, and functions not taking anything
+must still fill in the prototype with void. All comments must be in C-style /*
+and */ (the use of // is forbidden). Data shall be separated from code except
+on `for` loops. This rule must be applied recursively to each scope.
+
+AI
+==
+
+With the rising use of AI, it has became sensible to restrict the use of AI.
+
+AI can be used to generate code, or help debug, but the user must have plenty
+of knowledge about the generated source(s), a good way is trying to read the
+code after you paste it, or to type it out yourself.
+
+When debugging, AI will often leave comments like // FIX: or similar. These
+clutter the codebase with comment only a single programmer understands.
+
+Of course, if a bug on this codebase becomes infamous, you can always leave a
+note like:
+
+ /* fixes the $BUG bug
+ * - your name
+ */
+
+AI is completely forbidden for documentation.
+
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,122 @@
+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.
+
diff --git a/README b/README
@@ -0,0 +1,14 @@
+ ***********************************************
+ * slash -- a dead simple programming language *
+ ***********************************************
+
+slash a simple programming language based on (simple enough) OOP and a rich
+type system based on structural, strong typing and dependent types.
+
+The file extension is .slash, and ,sclass. This is the compiler source tree,
+written in C99 with a set of rigorous rules for quality.
+
+See the LICENSE file for licensing information, the HACKING file for contributing,
+the CONTRIBUTORS and .mailmap files for a list of contributors, and the TODOS file
+for goals we are working towards.
+
