Skip to content

Commit 1d313dc

Browse files
committed
WIP README
1 parent c69afc7 commit 1d313dc

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

vyxal/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<img src="https://raw.githubusercontent.com/rtoal/polyglot/master/docs/resources/vyxal-logo-64.png">
2+
3+
# Vyxal Explorations
4+
5+
To run Vyxal programs on your local machine, download and install the most recent language version from the [Vyxal downloads page](https://www.python.org/downloads/) or use your favorite package manager.
6+
7+
Programs in this folder have been tested using Python 3.13.2 and can be run from the command line like so:
8+
9+
```
10+
python3 triple.py
11+
```
12+
13+
```
14+
python3 permutations.py I like carrots
15+
```
16+
17+
```
18+
python3 top_ten_scorers.py < ../test/wnba_input
19+
```
20+
21+
Running the command `python3` with no arguments gives you a repl.
22+
23+
If you, as you may have already, are using virtual environments or have aliased `python3` to `python`, you may replace `python3` with `python` in the above commands.
24+
25+
To run the tests, invoke `./test.sh` in a Unix-friendly shell or `test.ps1` in PowerShell.
26+
27+
## About
28+
29+
Vyxal is a golf programming language that (TODO)
30+
31+
## Resources
32+
33+
- [Language Home](https://vyxal.github.io/)
34+
- [Online Interpreter](https://vyxal.github.io/latest.html#H4sIAAAAAAAACqtWSssvyk0sUbIy1lHKSE1MSS1SslJS0lFKzk9JhbDS8vNLYKJpOYnpxUpW0bE6Spl5BaUlUHZZalFxZn6ekpWSsZ65noFSLQAXTtVgVwAAAA)
35+
- [Official Documentation](https://www.python.org/doc/)
36+
- [Official Esolang Wiki](https://esolangs.org/wiki/Vyxal)
37+
- [Elements Documentation](https://github.com/Vyxal/Vyxal/blob/version-3/documentation/table.md)
38+
- [Vyxal at Rosetta Code](https://rosettacode.org/wiki/Category:Vyxal)
39+
- [GitHub](https://github.com/Vyxal/Vyxal)
40+
- [Discord](https://discord.gg/hER4Avd6fz)
41+
42+
43+

0 commit comments

Comments
 (0)