Skip to content

Commit 1bb65f5

Browse files
committed
add instructions for VM raw image
1 parent 15b1ed1 commit 1bb65f5

File tree

1 file changed

+53
-8
lines changed

1 file changed

+53
-8
lines changed

README.md

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,61 @@
11
# LilyDevOS
22

3-
This repository is meant to *become* an alternative to
3+
This repository is meant to be an alternative to
44
[LilyDev](https://github.com/fedelibre/LilyDev).
55

6-
Currently it provides just a container which can be run only on Linux hosts.
7-
Next step will be building images which include a desktop environment and
8-
can be loaded on virtual machine software on Mac and Windows.
6+
It provides two different options: a lightweight container for Linux hosts
7+
only and a full VM image for all operating systems.
98

109

11-
## How to use the images released
10+
## How to use the images
1211

13-
Requirements: Linux host, systemd-nspawn.
12+
### Full virtual machine
13+
14+
Runs on: any OS with a Virtual Machine software.
15+
16+
Download the latest [release](https://github.com/fedelibre/LilyDevOS/releases).
17+
The image built for being emulated on VM software has a `-vm` suffix.
18+
19+
You must first decompress the zip archive. Then you can verify the integrity
20+
of the data comparing the hash in the SHA256SUMS file with the output of
21+
this command (in Linux):
22+
23+
sha256sum lilydevos-vm-VERSION.raw
24+
25+
In Linux there are several VM GUI managers, like Virt Manager or Gnome Boxes.
26+
But you can also use the command line. Something like this should work (tested
27+
on Fedora):
28+
29+
qemu-kvm -m 512 -smp 2 -bios /usr/share/edk2/ovmf/OVMF_CODE.fd -drive format=raw,file=lilydevos-vm-VERSION.raw
30+
31+
512M of RAM *should* be enough, as the image contains also a swap partition
32+
of 2G. If you can assign 1024M, even better.
33+
In case you see some weird error while compiling lilypond, your guest might be
34+
running out of memory (check the RAM available with the command `free -m`)
35+
and you should try assigning more RAM to the virtual machine.
36+
37+
You'll log in as `dev` user (the password is `lilypond`).
38+
39+
Desktop preferences suggestions:
40+
41+
- Disable the screensaver: click on the menu icon on the bottom left, then
42+
on *Preferences»Monitor settings*; in the Mode dropdown menu choose
43+
*Disable Screen Saver*.
44+
45+
- Change keybord layout from default US (american) to your national layout in
46+
*Preferences»Keyboard and Mouse»Keyboard Layout*; add your layout and
47+
then move it up to the list so it will be the default.
48+
49+
50+
### Container
51+
52+
Runs on: Linux only.
53+
Requirements: systemd.
54+
55+
It's the best choice if you want to run LilyDevOS in a Linux host: lightweight,
56+
full access to host system resource (including RAM), easy access from host
57+
to guest file system through the file manager (so no need to set up shared
58+
folders).
1459

1560
Download the latest [release](https://github.com/fedelibre/LilyDevOS/releases).
1661
You need root privileges to extract the content, so you'd better do it on
@@ -32,7 +77,7 @@ the regular user `dev`, go to the home directory and run the setup.sh script:
3277
You are now ready to start contributing to LilyPond.
3378

3479
Remember that `dev` user can get root privileges with `sudo` (even if you
35-
should not need it).
80+
should not need it). The password is `lilypond`.
3681

3782
There's a good chance that your user in the Linux host and the `dev` user
3883
in the container have the same uid (probably 1000, use the command `id`
@@ -57,5 +102,5 @@ Usage is printed with this command:
57102

58103
mkosi --help
59104

60-
The command used to build LilyDevOS is in the Makefile.
105+
The commands used to build the images are in the Makefile.
61106

0 commit comments

Comments
 (0)