Make it more complete

This commit is contained in:
2026-06-14 21:25:53 -05:00
parent 9524778bc1
commit 4f10b98ab0
9 changed files with 192 additions and 17 deletions

1
.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
site

View File

@@ -3,6 +3,7 @@ FROM squidfunk/mkdocs-material:9 AS www-build
COPY ./ /src
WORKDIR /src
RUN pip install mkdocs-nav-weight
RUN mkdocs build
FROM git.tesses.org/tesses50/basic-webserver:latest

47
docs/cli.md Normal file
View File

@@ -0,0 +1,47 @@
---
weight: 3
---
# The CLI
I refer to it as the shell
## Creating new project
To determine all new templates use
```bash
crosslang new --list
```
And then create a project (in this example, its a console application)
```bash
mkdir mynewproject
cd mynewproject
crosslang new console
```
## Running code from source
```bash
crosslang run
```
## Pushing code to CPKG
You need [CPKG](../cpkg/) as I have registration disabled as of right now
```bash
crosslang login cpkg https://example.com/ #replace with your server
crosslang upload-package
```
## Installing stuff from CPKG
```bash
crosslang install-tool Tesses.YouTubeDownloader.MusicSync # not available yet
crosslang install-webapp Tesses.YouTubeDownloader.Server # or whatever
crosslang install-console MyConsoleApp
crosslang install-template Tesses.YouTubeDownloader.PluginTemplate # for making plugins for my Youtube Downloader
crosslang add-dependency Tesses.CrossLang.Std #in project folder
```
## Updating the CLI
If this is the first time you are using CrossLang it will ask you if you want to download the CLI (type y) and press enter, or define environment variable CROSSLANG_CONTAINER=y
If you have an out of date cli use
```bash
crosslang update-shell
```

72
docs/cpkg.md Normal file
View File

@@ -0,0 +1,72 @@
---
weight: 4
---
# Setting up CPKG
## With Docker
docker-compose.yml:
```yaml
services:
pkg:
image: git.tesses.org/tesses50/cpkg:latest
ports:
- "4206:4206"
volumes:
- data:/data
volumes:
data:
```
```bash
docker compose up -d
```
## Without Docker
- [CrossLang](downloads)
- [CPKG, use CPKG.crvm in releases](https://git.tesses.org/tesses50/crosslangextras/releases)
```bash
crosslang vm CPKG.crvm /path/to/where/cpkg/will/lie
```
## Setup for the first time
Launch your browser and go to [CPKG](http://127.0.0.1:4206/) (this link works if running locally on your machine)
- Click [Login](http://127.0.0.1:4206/login)
- Click Sign Up
- Fill out the form with your info
- Click Sign Up
- Click [Login](http://127.0.0.1:4206/login) again and login this time
## Uploading packages
There are a few ways of doing this
- [Upload](http://127.0.0.1:4206/upload) link on CPKG
- Signing in via [CLI](./cli/#pushing-code-to-cpkg)
- [API Key](#uploading-packages-via-api-key)
## Uploading packages via API key
This is useful in CI/CD pipelines
- Click your Display Name
- Click `Sessions`
- Click `Create API Key`
- Type in a name for the key
- Click `Create`
- Copy the API key
```bash
crosslang upload-package --host=https://YourCPKGHost/ --token=YourAPIKey # you can optionally place a crvm file afterwards if you aren't in the folder of project
```
## Adding custom CPKG for CrossLang
```bash
crosslang cpkg add https://YourCPKGHost/
```

49
docs/downloads.md Normal file
View File

@@ -0,0 +1,49 @@
---
weight: 2
---
# Downloads
[View On Gitea](https://git.tesses.org/tesses50/crosslang/releases)
## Arch Linux
You need to add our repository key
```bash
wget -O repository.key https://git.tesses.org/api/packages/tesses50/arch/repository.key
sudo pacman-key --add repository.key
```
Add this to your /etc/pacman.conf
```
[tesses50.git.tesses.org]
SigLevel = Optional TrustAll
Server = https://git.tesses.org/api/packages/tesses50/arch/core/$arch
```
or run this command which will do the same thing
```bash
printf "[tesses50.git.tesses.org]\nSigLevel = Optional TrustAll\nServer = https://git.tesses.org/api/packages/tesses50/arch/core/\$arch\n" | sudo tee -a /etc/pacman.conf
```
Install crosslang
```bash
sudo pacman -Sy crosslang
```
## Brew (MacOS/Linux)
Install [brew](https://brew.sh/) if you have not already
```bash
brew tap tesses50/tesses-tap https://git.tesses.org/tesses50/tesses-tap
```
```bash
brew install tesses50/tesses-tap/crosslang
```
## Windows
TODO: IMPLEMENT

4
docs/images/logo.svg Normal file
View File

@@ -0,0 +1,4 @@
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' aria-hidden='true' role='img' class='iconify iconify--logos' width="100" height="100">
<polygon points="50,5,95,30,95,70,50,95,5,70,5,30" style="fill:orange;stroke:black;stroke-width:3" />
<polygon points="45,20,55,20,55,35,80,35,80,45,55,45,55,85,45,85,45,45,20,45,20,35,45,35" style="fill:white;stroke:black;stroke-width:3"/>
</svg>

After

Width:  |  Height:  |  Size: 425 B

View File

@@ -1,17 +1,9 @@
# Welcome to MkDocs
---
weight: 1
---
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
# Home
My programming language
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
> John 3:16: For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.

View File

@@ -1,3 +0,0 @@
# My Second Page
Cool

View File

@@ -1 +1,13 @@
site_name: CrossLang
site_url: https://crosslang.tesseslanguage.com
repo_url: https://git.tesses.org/tesses50/crosslang
repo_name: tesses50/crosslang
theme:
name: material
logo: images/logo.svg
favicon: images/logo.svg
icon:
repo: fontawesome/brands/git-alt
plugins:
- search
- mkdocs-nav-weight