index.md 2.36 KB
Newer Older
1
% tethercode docs
Jonas Thiem's avatar
Jonas Thiem committed
2

3
<!--
4
    This file is part of the tethercode documentation.
J. T.'s avatar
J. T. committed
5 6 7
    Licensed under
    CC-By-4.0 https://creativecommons.org/licenses/by/4.0/
    Attribution:
8
    tethercode dev team https://tethercode.io/go/authors
9 10
-->

Jonas Thiem's avatar
Jonas Thiem committed
11 12
# Documentation

J. T.'s avatar
J. T. committed
13
Welcome!
14

J. T.'s avatar
J. T. committed
15
You are reading the documentation of the tethercode programming language.
16

17
![](icons/download.png)
18

J. T.'s avatar
J. T. committed
19 20
**Get it:** [Click to get the language tools / SDK](https://tethercode.io/#get)

21
![](icons/rocket.png)
22 23 24

**Learn it:** [START HERE for a basic introduction.](
    tutorials/getting-started.md)
Jonas Thiem's avatar
Jonas Thiem committed
25 26


Jonas Thiem's avatar
Jonas Thiem committed
27
## Available topics
Jonas Thiem's avatar
Jonas Thiem committed
28

29
### Getting started
30
- **Getting started**: [how to set up tethercode to be able to test
J. T.'s avatar
J. T. committed
31
    and run code](tutorials/getting-started.md).
32
- **Beginner's tutorials**: [simple tutorials to get started with tethercode
Jonas Thiem's avatar
Jonas Thiem committed
33
    as a newcomer](basic-tutorials.md)
J. T.'s avatar
J. T. committed
34 35
- **Frequently asked questions**: [a common set of questions you might
    have when learning tethercode](faq.md)
36 37
- **Advanced how-tos**: [advanced how-tos showing how to do various
    more in-depth common projects like a server](howtos.md)
Jonas Thiem's avatar
Jonas Thiem committed
38

39
### Reference
40 41
- **Design principles**: [explanation of underlying principles, including
    for concurrency in tethercode](principles.md)
42
- **Specification**: [basic language syntax and formal definition](specification.md)
43
- **Runtime**: [information on how the runtime works](runtime.md)
44

Jonas Thiem's avatar
Jonas Thiem committed
45
## Misc information
Jonas Thiem's avatar
Jonas Thiem committed
46

47
### I am absolutely stuck, help me!
48
If you are writing something in tethercode and you can't get it to work and you
49 50 51 52
require external help, you might wanna check the official
 [discussion mailing list](https://lists.wobblylang.org).
There are also [other places to ask for help](community.md).

Jonas Thiem's avatar
Jonas Thiem committed
53
### Where to get it?
54 55
Get the latest version of the tethercode programming language development
tools from the [official website](https://tethercode.io), and
56
the current source code from the [public code repository](
57
    https://gitlab.com/tethercode/stdlib)!
Jonas Thiem's avatar
Jonas Thiem committed
58

Jonas Thiem's avatar
Jonas Thiem committed
59
### I found a bug!
60
If you find any bugs or encounter any issues, please check the
61
[contribution guide's section on how to report a bug](../CONTRIBUTING.md).
62
You are also free to report issues with this documentation or the official
63
website at [https://tethercode.io](https://tethercode.io).
Jonas Thiem's avatar
Jonas Thiem committed
64

65
### Other useful tools
66 67 68
This list will be expanded once we find nice ones!
If you wrote one and want it added here, please tell us on the
[mailing list](https://lists.wobblylang.org).
Jonas Thiem's avatar
Jonas Thiem committed
69