threeoh6000/granite-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add shtuff

Browse source
This commit is contained in:
abbie 2024-08-16 14:48:06 +01:00
commit 708cc6a0c3
Signed by: threeoh6000
GPG key ID: 801FE4AD456E922C
14 changed files with 1303 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

438
LICENCE Normal file
View file

@ -0,0 +1,438 @@
Attribution-NonCommercial-ShareAlike 4.0 International
=======================================================================
Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are
intended for use by those authorized to give the public
permission to use material in ways otherwise restricted by
copyright and certain other rights. Our licenses are
irrevocable. Licensors should read and understand the terms
and conditions of the license they choose before applying it.
Licensors should also secure all rights necessary before
applying our licenses so that the public can reuse the
material as expected. Licensors should clearly mark any
material not subject to the license. This includes other CC-
licensed material, or material used under an exception or
limitation to copyright. More considerations for licensors:
wiki.creativecommons.org/Considerations_for_licensors
Considerations for the public: By using one of our public
licenses, a licensor grants the public permission to use the
licensed material under specified terms and conditions. If
the licensor's permission is not necessary for any reason--for
example, because of any applicable exception or limitation to
copyright--then that use is not regulated by the license. Our
licenses grant only permissions under copyright and certain
other rights that a licensor has authority to grant. Use of
the licensed material may still be restricted for other
reasons, including because others have copyright or other
rights in the material. A licensor may make special requests,
such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More considerations
for the public:
wiki.creativecommons.org/Considerations_for_licensees
=======================================================================
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
Public License
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International Public License
("Public License"). To the extent this Public License may be
interpreted as a contract, You are granted the Licensed Rights in
consideration of Your acceptance of these terms and conditions, and the
Licensor grants You such rights in consideration of benefits the
Licensor receives from making the Licensed Material available under
these terms and conditions.
Section 1 -- Definitions.
a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. BY-NC-SA Compatible License means a license listed at
creativecommons.org/compatiblelicenses, approved by Creative
Commons as essentially the equivalent of this Public License.
d. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.
e. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.
f. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
g. License Elements means the license attributes listed in the name
of a Creative Commons Public License. The License Elements of this
Public License are Attribution, NonCommercial, and ShareAlike.
h. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.
i. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.
j. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
k. NonCommercial means not primarily intended for or directed towards
commercial advantage or monetary compensation. For purposes of
this Public License, the exchange of the Licensed Material for
other material subject to Copyright and Similar Rights by digital
file-sharing or similar means is NonCommercial provided there is
no payment of monetary compensation in connection with the
exchange.
l. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.
m. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.
n. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 -- Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:
a. reproduce and Share the Licensed Material, in whole or
in part, for NonCommercial purposes only; and
b. produce, reproduce, and Share Adapted Material for
NonCommercial purposes only.
2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.
3. Term. The term of this Public License is specified in Section
6(a).
4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.
5. Downstream recipients.
a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.
b. Additional offer from the Licensor -- Adapted Material.
Every recipient of Adapted Material from You
automatically receives an offer from the Licensor to
exercise the Licensed Rights in the Adapted Material
under the conditions of the Adapter's License You apply.
c. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.
6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this
Public License.
3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties, including when
the Licensed Material is used other than for NonCommercial
purposes.
Section 3 -- License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified
form), You must:
a. retain the following if it is supplied by the Licensor
with the Licensed Material:
i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of
warranties;
v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;
b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and
c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.
3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.
b. ShareAlike.
In addition to the conditions in Section 3(a), if You Share
Adapted Material You produce, the following conditions also apply.
1. The Adapter's License You apply must be a Creative Commons
license with the same License Elements, this version or
later, or a BY-NC-SA Compatible License.
2. You must include the text of, or the URI or hyperlink to, the
Adapter's License You apply. You may satisfy this condition
in any reasonable manner based on the medium, means, and
context in which You Share Adapted Material.
3. You may not offer or impose any additional or different terms
or conditions on, or apply any Effective Technological
Measures to, Adapted Material that restrict exercise of the
rights granted under the Adapter's License You apply.
Section 4 -- Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database for NonCommercial purposes
only;
b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material,
including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.
Section 6 -- Term and Termination.
a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 -- Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.
Section 8 -- Interpretation.
a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.
=======================================================================
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.
Creative Commons may be contacted at creativecommons.org.

121
LICENCE-FOR-CODE-EXAMPLES-ONLY Normal file
View file

@ -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.

54
docs/dropping-variables.md Normal file
View file

@ -0,0 +1,54 @@
# Dropping variables
Sometimes in Granite, you may want to un-initalise a variable you initialised! This is easy to do.
## New operations
* `:$(variable)`, variable drop, deletes `(variable)`
## Tutorial
Look at this simple program:
```
:?x
:^x
:!x
:?x
:ax,x,x
:!x
```
This program is fairly simple, what we expect is that it will prompt the user twice and do some maths on their number!
What we _instead_ get is this:
```
? 9
10
105
10
```
This is not very nice looking as it is interpreting the users first input as a prompt.
To fix this, use `:$x` after the first print operation to drop the `x` variable!
Now your output can look like this:
```
? 9
10
? 5
10
```
Much better!
## After example
```
:?x
:^x
:!x
:$x
:?x
:ax,x,x
:!x
```

92
docs/finishing-touches.md Normal file
View file

@ -0,0 +1,92 @@
# Finishing touches!
Now you have a perfectly working counter program! For your final lesson however, we will teach you about comments and explicitly exiting the program!
## New operations
* `:0(comment)`, comment, an operation that does nothing but is helpful for a programmer!
* `:~`, exit, explicitly calls an exit to your program
* `:*(left),(right),(output)`, string concatenation, concatenates `(left)` and `(right)` and stores it in `(output)`
## Tutorial
Your program should look something like this:
```
:>"Enter some numbers!",message
:!message
:?starting_number
:?finishing_number
:?step
:@count
:astarting_number,step,starting_number
:!starting_number
:-count,starting_number,finishing_number
```
This program is perfectly readable, however it could do with some comments and an obvious exit point!
You can add comments as an operation and it wont affect your program! So you could do something like this!
```
:>"Enter some numbers!",message
:!message
:0 Prompt the user for their chosen numbers!
:?starting_number
:?finishing_number
:?step
:0 Keep counting until we hit the finishing number
:@count
:astarting_number,step,starting_number
:!starting_number
:-count,starting_number,finishing_number
:0 We're done! Quit!
:~
```
We can also add a concatenation! Before the explicit exit, initialise the variable `msg` with the string `"I have counted to "`! After this operation, add the operation `:*msg,finishing_number,msg` and print out message!
Now when your program finishes, it will tell you what your program counted to!
Now your output will look like this if you run your program!
```
Enter some numbers!
? 0
? 5
? 1
1
2
3
4
5
I have counted to 5
```
## Continue the guidebook
Well done! You've finished the guidebook!
You can further your learning by going to the further concepts section on the top navigation bar!
## After example
```
:>"Enter some numbers!",message
:!message
:0 Prompt the user for their chosen numbers!
:?starting_number
:?finishing_number
:?step
:0 Keep counting until we hit the finishing number
:@count
:astarting_number,step,starting_number
:!starting_number
:-count,starting_number,finishing_number
:0 We're done! Quit!
:>"I have counted to ",msg
:*msg,finishing_number,msg
:!msg
:~
```

18
docs/index.md Normal file
View file

@ -0,0 +1,18 @@
# Welcome to the documentation
Granite is a toy programming language focused around being unconventional but still comfortable to use.
The main implementation of Granite is written in Rust and is capable of both parsing and executing Granite programs.
## Where to start
It is recommended all new Granite programmers start at the syntax introduction to get familiar with how a Granite program is laid out.
Those familiar with the Granite language should use the reference to remind themselves of the operations or the further concepts section in the navbar to learn about things not covered in the guidebook!
* [Syntax introduction](syntax-intro.md)
* [Operation reference](reference.md)
## Information
This version of the documentation is intended for Granite v1.0.2 and if you are running a newer version, there may be new features that aren't documented here or old features that no longer work.
This documentation is licenced under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International licence. All code examples within this documentation are dedicated to the public domain according to the CC0 1.0 Universal licence.

93
docs/jumps-labels.md Normal file
View file

@ -0,0 +1,93 @@
# Jumps and labels
Granite does not have conventional loops similar to a C-like programming language does. It instead is more alike to BASIC having _labels_ and jumps.
Labels are operations that have no direct function when ran in the program _but_ they mark where you can jump to! Jumps move where the program is being ran from to labels! These tools together allows you to create loops!
## New operations
* `:@(label)`, label, places a new label at this location
* `:<(label)`, unconditional jump, jumps to this label without any condition
* `:-(label),(variable),(check)`, jump if less than, jumps to this label if `(variable)` is less than `(check)` which can be a variable or an integer literal.
* `:a(left),(right),(output)`, add, performs `(left)` add `(right)` and stores the result into `(output)`
There are also `+` and `=` operators which function like the `-` operator but check if `(variable)` is greater than (for `+`) or equal to (for `=`) `(check)` instead.
There are also `s`, `m` and `d` operators which function like the `a` operator but perform subtraction, multiplication, and division respectively.
## Tutorial
Open up your program! It should look something like this:
```
:>0,starting_number
:^starting_number
:!starting_number
```
At the top of your program's source code add this operation:
`:>1,step`
This defines your counter's _step_!
Now _replace_ the increment operation with this add operation:
`:astarting_number,step,starting_number`
What this operation does is takes `starting_number` and `step` and adds them together and then stores that into `starting_number`!
If you run your program now, you should get the number 1 as an output. Wonderful!
Now to add _looping_!
Your program should look like this:
```
:>1,step
:>0,starting_number
:astarting_number,step,starting_number
:!starting_number
```
As we are _counting_ up, we want to loop where the counting happens and _not_ where the variable setting happens!
This means we want to _set a new label_ above the add operation so above the add operation, add this operation:
`:@count`
By itself, this won't create a loop but we can do that easily! At the bottom of your program, below the print operation, add a new unconditional jump operation!
`:<count`
Now if you start your program, you will see it spit out a stream of numbers as it quickly keeps counting from 0! If this happens, wonderful, you've just created your first loop!
Exit the program (this will most likely be with `Control + C`) and re-enter the source code! We want to count up to a certain number, let's say 10!
To do this, at the top of your program, initialise a new variable called `finishing_number` with the number 10 in it!
Now at the bottom of your program, _replace_ your unconditional jump operation with this conditional one!
`:-count,starting_number,finishing_number`
This conditional jump will continue looping until `starting_number` is not less than `finishing_number`!
If you run your program now you should see this output:
```
1
2
3
4
5
6
7
8
9
10
```
Congratulations! You've not only made loops but _also_ loops that break when a condition is met!
## Extension
Try messing with the `step` and `finishing_number` variables to see different outputs when you add more in one loop around!
## Continue the guidebook
* [Next page: Taking input from the user](taking-input.md)

50
docs/manipulating-values.md Normal file
View file

@ -0,0 +1,50 @@
# Manipulating values
Granite does not allow you to modify literals directly, instead requiring you to use bindings to variables and modifying them within bindings, keeping all values tracked and stored.
## New operations
* `:>(value),(variable)`, set variable, Stores `(value)` into `(variable)`
* `:^(variable)`, increment, if `(variable)` is a number, add one to it.
* `:v(variable)`, decrement, if `(variable)` is a number, remove one from it.
* `:!(variable)`, print, outputs the value in `(variable)`
## Tutorial
To begin your program, make a new file called `counter.granite`. This will be the source code of your program!
Throughout this guidebook, we will be creating a program which is able to count up from a starting number to a final number by a certain step each time! To do this, we first need to learn the basics of value manipulation.
In your program's source place these two statements in:
```
:>0,starting_number
:!starting_number
```
These two statements will simply create (initialise) the `starting_number` variable with the value 0 and print it to the screen!
Now run your program with the Granite runtime. There are two ways to do this:
* If you have installed Granite to your path, type `granite -i counter.granite`.
* If you are in your local clone of the Granite runtime repository, type `cargo run -- -i counter.granite`.
You should now see the program run and output 0!
If the program does _not_ run and gives you an error, make sure your source code matches the above example _exactly_. The Granite language does not like having spaces between variables and commas, and will fail if you add spaces.
Next, we want to _manipulate_ the value. We can do this by using the `:^(variable)` operation!
Make your program's source code look like _this_ now:
```
:>0,starting_number
:^starting_number
:!starting_number
```
Now run your program, you should see the number 1!
## Extension
Try using the _decrement_ operation (`:v(variable)`) to make the output a negative number!
## Continue the guidebook
* [Next page: Jumps and labels](jumps-labels.md)

112
docs/reference.md Normal file
View file

@ -0,0 +1,112 @@
# Operation reference
This is a reference of all the possible operations in the Granite programming language. This may be useful for those who have read through both the guidebook and all the further concepts who just need a refresher or those who have read the syntax introduction and prefer to learn by reading references.
## Set variable
Operation: `:>(value),(variable)`
Stores `(value)` into `(variable)`.
## Increment
Operation: `:^(variable)`
Adds 1 to `(variable)` if it is a number. Panics if not.
## Decrement
Operation: `:v(variable)`
Removes 1 from `(variable)` if it is a number. Panics if not.
## Print
Operation: `:!(variable)`
Outputs the value in `(variable)`.
## New label
Operation: `:@(label)`
Defines a new label at this location called `(label)`.
## Unconditional jump
Operation: `:<(label)`
Jumps to `(label)` without any condition.
## Jump if less than
Operation: `:-(label),(variable),(check)`
Jumps to `(label)` if `(variable)` is less than `(check)` which can be an integer or a variable.
## Jump if greater than
Operation: `:+(label),(variable),(check)`
Jumps to `(label)` if `(variable)` is greater than `(check)` which can be an integer or a variable.
## Jump if equal to
Operation: `:=(label),(variable),(check)`
Jumps to `(label)` if `(variable)` is equal to `(check)` which can be an integer or a variable.
## Arithmetic add
Operation: `:a(left),(right),(output)`
Performs `(left) + (right)` and stores the result into `(output)`
## Arithmetic subtract
Operation: `:s(left),(right),(output)`
Performs `(left) - (right)` and stores the result into `(output)`
## Arithmetic multiply
Operation: `:m(left),(right),(output)`
Performs `(left) * (right)` and stores the result into `(output)`
## Arithmetic divide
Operation: `:d(left),(right),(output)`
Performs `(left) / (right)` and stores the result into `(output)`
## Take input
Operation: `:?(variable)`
Prompts the user for input and stores it in `(variable)`. If `(variable)` is not initialised then prompt the user with a `? ` prompt otherwise prompt the user with the value of `(variable)`.
## Comment
Operation: `:0(comment)`
Does nothing but leaves a useful comment for programmers.
## String concatenation
Operation: `:*(left),(right),(output)`
Concatenates `(left)` and `(right)` into one string and places the result into `(output)`.
## Explicit exit
Operation: `:~`
Terminates the program at this point.
## Type check
Operation: `:&(variable),(output)`
Sets `(output)` to 1 if `(variable)` is an integer, otherwise sets `(output)` to 0.
## Stack push
Operation: `:#`
Pushes the current location to the stack, allowing the programmer to return out of a subroutine.
## Return
Operation: `:|`
Returns back to previously pushed location, panics if no location previously pushed.
## Variable clone
Operation: `:%(source),(target)`
Stores the value of `(source)` in `(target)`.
## Variable drop
Operation: `:$(variable)`
Deletes `(variable)`, effectively un-initialising it.

65
docs/subroutines.md Normal file
View file

@ -0,0 +1,65 @@
# Subroutines
Sometimes in Granite, you will need to be able to call subroutines (a kind of function) instead of jumping and be able to _return_ to where you were before. This is possible!
## New operations
* `:#`, stack push, pushes the current location to the stack, allowing a return
* `:|`, return, returns back to the previous pushed location, crashes if no location pushed
## Tutorial
Look at this program:
```
:?x
:&x,temp
:=default,temp,0
:@print
:^x
:!x
:~
:@default
:>10,x
:<print
```
This program will take a number, add 1 to it and print it out, but default to 10 if a string is passed in.
A more nicer way to do this could be with subroutines!
First, move the default label and its two operations above the prompt and define an entry label above the prompt but below the default label like this:
```
:<entry
:@default
:>10,x
:<print
:@entry
:?x
:&x,temp
:=default,temp,0
:^x
:!x
```
Now before the conditional jump to default after the type check, add a `:#` operation and replace the `:<print` operation with `:|`
The program now functions the same, but looks much more neater with subroutines!
## After example
```
:<entry
:@default
:>10,x
:|
:@entry
:?x
:&x,temp
:#
:=default,temp,0
:^x
:!x
```

25
docs/syntax-intro.md Normal file
View file

@ -0,0 +1,25 @@
# Syntax introduction
Every Granite program is made up of "operations", a combination of operators and any number of arguments, including zero! These operations all begin with a `:` to denote the beginning of an operation, an operator, and then variables that are comma separated.
An example of a statement is the "set variable" operation, `:>10,balance`.
The statement example above simply places the integer 10 into the variable `balance`. The language's syntax may be a bit esoteric but it isn't too hard to wrap your head around!
The Granite language does not need spaces between arguments in an operation and if you add these they will be interpreted as different to how you expect!
For example the following two programs may look similar:
* `:>10,x:^x`
* `:> 10,x:^x`
but the bottom one will fail with the error `Non-number variable x on increment.` due to it perceiving the value as the string " 10" and not the integer 10.
## Types
Granite has two types: integers and strings.
Hence, Granite features no native support for floating point numbers however this can be emulated using fixed point mathematics (we do not go into this in this guidebook and should be independently researched if wanted).
Integers are considered integers if they can be coerced in string form, e.g. the string "52" can be coerced into the integer 52 hence it is an integer but the string "5 2" cannot as it is not exactly the same as a number.
## Continue the guidebook
* [Next page: Manipulating values](manipulating-values.md)

54
docs/taking-input.md Normal file
View file

@ -0,0 +1,54 @@
# Taking input from the user
Granite has a special operation that allows you to ask your user for a value to place into a variable! This is useful for asking your user things, like what is their name!
## New operations
* `:?(variable)`, take input, asks the user for input, if there is a value in (variable) then prompt them with this otherwise present them with a `? ` prompt
## Tutorial
Your program should look something like this at this point:
```
:>10,finishing_number
:>1,step
:>0,starting_number
:@count
:astarting_number,step,starting_number
:!starting_number
:-count,starting_number,finishing_number
```
We want to _ask_ the user to input numbers by giving them a prompt!
At the top of your program, initialise a variable called `message` and add anything you want! Just make sure it's obvious to the user that you are asking them for numbers then print out this variable immediately after!
Now, we want to _ask_ the user for their numbers!
Replace the variable definitions for `finishing_number`, `step` and `starting_number` with these three statements:
```
:?starting_number
:?finishing_number
:?step
```
Now execute your program! You should see something like this:
```
Enter some numbers!
?
```
Now if you put in 0, then 10 and then 1 you will see the same output as you would have before!
## Extension
Can you make each prompt for the variables output a message for each one like this?:
```
Enter some numbers!
Starting number? 0
Finishing number? 10
Step?
```
## Continue the guidebook
* [Final page: Finishing touches!](finishing-touches.md)

63
docs/type-checking.md Normal file
View file

@ -0,0 +1,63 @@
# Type checking
Granite contains two types: integers and strings, and due to how some operations work it may be worth type checking these explicitly within the code.
## New operations
* `:&(variable),(output)`, type check, if `(variable)` is an integer then set `(output)` to 1 otherwise set `(output)` to 0
## Tutorial
Look at this simple program:
```
:?x
:^x
:!x
```
This program simply asks the user for a number and adds 1 to it.
This program works fine _provided the user inputs a number_.
```
? 50
51
```
But things begin to fall apart if the user does not input an integer.
```
? I'm an evil string! >:)
Non-number variable x on increment.
```
Type checking can solve this problem by allowing the programmer to safely recover when an invalid type is detected.
Firstly, we want to make the question a label so make a label called `question` above `:?x`.
Also add a [variable drop](dropping-variables.md) after the `question` label but _before_ asking the user for `x`.
Now directly after `:?x` but _before_ `:^x` we want to add the type check operation so add `:&x,type` after `:?x`.
Now we will have an integer corresponding to whether `x` is an integer or not. So _now_ after `:&x,type` you can add a conditional jump that jumps to the `question` label if `type` is equal to `0` which means that the user inputted a string.
Now our program is immune to strings messing things up:
```
? I'm an evil string! >:)
? No strings? :(
? 10
11
```
## Extension
Can you prompt the user to input an integer after incorrectly putting in a string?
## After example
```
:@question
:$x
:?x
:&x,type
:=question,type,0
:^x
:!x
```

100
docs/value-cloning.md Normal file
View file

@ -0,0 +1,100 @@
# Value cloning
Sometimes in Granite, you may want to _clone_ variables. This is fairly easy with one operation!
## New operations
* `:%(source),(target)`, variable clone, sets `(target)` to the value in `(source)`
## Tutorial
Imagine you want to create a program to calculate a Fibonacci sequence up to a certain term.
The first two numbers of the sequence are 0 and 1 and each next term is the sum of the previous two meaning that number #3 is number #1 (0) plus number #2 (1)
We can begin the program by initialising and printing the first terms and the counter and asking the user for a term:
```
:0 Init variables and ask user for term
:?a
:>2,i
:>0,x
:>1,y
:>0,z
:0 print term 0 and term 1 and stop if user didnt want more
:!x
:=exit,a,0
:!y
:=exit,a,1
:0 increment a for loop purposes
:^a
```
Now for the loop, first we want to perform the addition and increment i:
```
:@loop
:ax,y,z
:!z
:^i
```
Now we want to move the new term into `y` and the `y` term into `x`.
```
:%y,x
:%z,y
```
We need to clone the `y` term into `x` _first_
Now add the loop operation and premature exit label.
```
:-loop,i,a
:@exit
:~
```
Now run the program, you'll get an output similar to this after entering a number:
```
? 12
0
1
1
2
3
5
8
13
21
34
55
89
144
```
Congratulations! Now you can clone variables!
## After example
```
:?a
:>2,i
:>0,x
:>1,y
:>0,z
:!x
:=exit,a,0
:!y
:=exit,a,1
:^a
:@loop
:ax,y,z
:!z
:^i
:%y,x
:%z,y
:-loop,i,a
:@exit
:~
```

18
mkdocs.yml Normal file
View file

@ -0,0 +1,18 @@
site_name: Granite Language Documentation
theme:
name: mkdocs
color_mode: dark
nav:
- Home: 'index.md'
- 'Guidebook':
- 'Syntax introduction': 'syntax-intro.md'
- 'Manipulating values': 'manipulating-values.md'
- 'Jumps and labels': 'jumps-labels.md'
- 'Taking input from the user': 'taking-input.md'
- 'Finishing touches!': 'finishing-touches.md'
- 'Further concepts':
- 'Type checking': 'type-checking.md'
- 'Subroutines': 'subroutines.md'
- 'Value cloning': 'value-cloning.md'
- 'Dropping variables': 'dropping-variables.md'
- 'Operation reference': 'reference.md'