Browse Source

Update README

v5
minexew 1 year ago
parent
commit
5bbf7e6234
  1. 20
      QEMU.md
  2. 31
      README.md

20
QEMU.md

@ -0,0 +1,20 @@
Shrine is right at home in QEMU. (In fact, for many years QEMU was needed to build Shrine itself!)
First, you should create a virtual disk (you can adjust the size to your preference):
qemu-img create -f qcow2 Shrine.HDD 2G
Then, to boot the Live CD and install to the disk:
qemu-system-x86_64 \
-cdrom Shrine.ISO -boot d \
-drive format=qcow2,file=Shrine.HDD \
-machine kernel_irqchip=off \
-smp cores=4 \
-m 2048 \
-rtc base=localtime \
-soundhw pcspk \
-netdev user,id=u1 -device pcnet,netdev=u1
Follow the on-screen instructions. When the installer finishes and prompts for a reboot,
simply close the VM and restart it by repeating the previous command, omitting the `-cdrom Shrine.ISO -boot d`.

31
README.md

@ -1,15 +1,17 @@
Shrine
======
Shrine is a TempleOS distribution full of sin.
![Screenshot](http://imgur.com/1yYsUHI.png)
Shrine is a TempleOS distribution that aims to be more modern & approachable.
Shrine aims to be 99% compatible with TempleOS programs, but also to improve OS in several ways:
- Ease of use: Shrine ships with Lambda Shell, which feels a bit like a classic Unix command interpreter
- Connectivity: TCP/IP stack & internet access out of the box
- Software discovery: Shrine includes a package downloader
Shrine aims to improve upon TempleOS in several aspects:
- Approachability: Shrine ships with Lambda Shell, a more traditional Unix-like command interpreter
- Connectivity: TCP/IP stack! Internet access!
- Software access: Shrine includes a package downloader
- Versatility: unlike stock TempleOS, Shrine requires only 64MB RAM, making it feasible for cloud micro-instances and similar setups (note: this is planned, but currently not true)
You can run Shrine in a virtual machine such as VirtualBox or [QEMU](QEMU.md), or on a machine compatible with standard TempleOS. Improvements in hardware support are planned and contributions are welcome.
Software included in Shrine:
- Mfa (minimalist file access)
@ -17,27 +19,28 @@ Software included in Shrine:
- Pkg (package downloader)
- Wget
Setting up with networking
==========================
- Native Stack (highly experimental)
- configure your VM networking: *Adapter Type: PCnet-PCI II* (QEMU: `-netdev user,id=u1 -device pcnet,netdev=u1`)
Networking & host-VM communication
==================================
- With a virtual AMD PCNet adapter (recommended)
- configure your VM networking: *Adapter Type: PCnet-PCI II* (in QEMU: `-netdev user,id=u1 -device pcnet,netdev=u1`)
- *Attached to: NAT* seems to be the most reliable setting, Bridged Mode also works somewhat
- On boot, Shrine will automatically attempt to acquire an IP address. If you don't get a message about "Configuring network", the adapter was not detected.
- On boot, Shrine will automatically attempt to acquire an IP address. If you don't see a message about "Configuring network", the adapter was not detected.
- To enable tunelled networking through Snail:
- Tunelled through serial port (Snail):
- configure your VM: COM3 - TCP, server, 7777 (in VirtualBox, server = UNCHECK *Connect to existing*)
- (make sure to *disable* networking for the VM, otherwise Native Stack will get precedence)
- start the VM
- run ./snail.py
- you will now be able to access the Internet, try for example `pkg-list`
- To enable file access through Mfa, configure the VM as follows:
- File access through Mfa:
- configure your VM: COM1 - TCP, server, 7770
- start `/Apps/Mfa.HC.Z` in the VM
- on the host, use ./mfa.py to transfer commands and files
- for example: `./mfa.py list /Apps/Mfa.HC.Z Mfa.HC`
Both of these can be used simultaneously.
Networking and Mfa can be used simultaneously.
Package management functions
============================

Loading…
Cancel
Save