Go to file

Leon van Kammen 10e994e0b3 / mirror_to_github (push) Failing after 57s Details / test (push) Successful in 6s Details main: work in progress [might break]		2024-12-11 15:44:54 +01:00
.forgejo/workflows	mirror_to_github action++++++	2024-04-30 14:55:48 +02:00
.github/workflows	GH action	2024-05-30 14:50:23 +00:00
nix	made make-script compatible with nix	2024-10-28 11:12:18 +00:00
src	README.md added logo	2024-11-21 20:24:57 +01:00
.args	build fix: now opens browser correctly	2024-09-24 11:07:14 +00:00
.gitignore	main: minor bugfix	2024-07-23 13:17:10 +00:00
.gitmodules	temporary remove xrsh-buildroot subrepo	2024-10-31 17:47:49 +01:00
LICENSE	Initial commit	2023-11-01 11:14:44 +01:00
README.md	main: work in progress [might break]	2024-12-11 15:44:54 +01:00
cosmopolitan.nix	made make-script compatible with nix	2024-10-28 11:12:18 +00:00
index.html	main: work in progress [might break]	2024-12-11 15:44:54 +01:00
make	make typofix	2024-10-28 14:13:06 +00:00
package.zip	zip packages now have .env as entrypoint [like autoenv]	2024-12-06 12:11:57 +00:00
result	made make-script compatible with nix	2024-10-28 11:12:18 +00:00
shell.nix	added tests/gifs with vhs	2024-08-26 19:57:35 +00:00
tags	made make-script compatible with nix	2024-10-28 11:12:18 +00:00
xrsh.com	new build with custom keyboard map	2024-11-21 11:29:39 +00:00
xrsh.com.txt	new build with custom keyboard map	2024-11-21 11:29:39 +00:00
xrsh.ico	added favico + svg logo + added logo to tiddlywiki	2024-11-21 20:05:53 +01:00
xrsh.iso	added xrsh-buildroot submodule	2024-10-30 15:46:08 +00:00
xrsh.nix	merged branch feat/copy-paste-drag-drop in src/com	2024-11-15 10:00:31 +00:00
xrsh.svg	added nlnet + ngi logo	2024-11-21 20:22:44 +01:00
xrsh.txt	made make-script compatible with nix	2024-10-28 11:12:18 +00:00

README.md

xrsh

click here for the website / hosted repo

XRSH Manual

Documentation for XRSH users can be found here

TIP: this is also available by typing ctrl/cmd+a+0 or man xrsh inside XRSH

Wiki / Roadmap

See the wiki here

Install

NOTE: installation is optional: just surf to the public version here

install using nix

NIX is a convenient way to install or develop xrsh:

run nix-run -p xrsh --run "xrsh.com" (pass -p XXXX to specify non-default 8080 port )
build it when package does not exist: nix-build -E "with import <nixpkgs> { }; callPackage ./xrsh.nix"

install without nix

Download xrsh.com
optional: run unzip xrsh.com to verify repository contents
run chmod +x xrsh.com in your console (only linux/mac)
run ./xrsh.com in (any) shell
Profit! ✔

launch different .iso / modify files

You can specify a different .iso file in various ways:

open the xrsh.com as a zip (drag-drop into a zip-manager, or add .zip extension)
method 1: overwrite xrsh.iso
method 2: open src/index.html and change isoterminal="iso: ./../xrsh.iso" to another file/URL

see developer-section below on building your own iso

The browser auto-launches https://localhost:8080 on most platforms

pass -p XXXX to specify port (default:8080)

Developers

Make sure to clone the repo including submodules (the xrsh-com repo)

$ git clone --recurse-submodules https://forgejo.isvery.ninja/xrsh/xrsh
$ cd xrsh
$ nix-shell  # optional but adviced (to get up and running instantly)

Now serve the repo from a HTTPS webserver (for example run ./make dev)

Run ./make standalone to package everything into xrsh.com

development of components (src/com) takes places in this git submodule
development of xrsh.iso takes places in this gitsubmodule

Funding

This project is funded through NGI0 Entrust, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet project page.

Inspired by

mimetype hooks: Future of Text [SLOAN companion]