Add Yaru-dark skin from ConLenov

[kolibrios.git] / data / eng / docs / INSTALL.TXT

System requirements\r
-------------------\r
\r
Minimal system requirements for KolibriOS:\r
* CPU 5x86: Pentium, AMD or Cyrix without MMX with frequency 90 MHz\r
* RAM: 8 MB\r
* Videocard: supporting VGA (640x480x16 mode) or VESA\r
* Keyboard: AT\r
* Mouse: COM, PS/2 or USB\r
\r
The system can boot from any of following devices:\r
* BIOS mode\r
  - Floppy 3.5\r
  - HDD LBA\r
  - CD/DVD\r
  - USB Flash\r
* UEFI mode\r
  - HDD\r
  - USB Flash\r
\r
\r
Installation: BIOS mode\r
-----------------------\r
\r
### Install to floppy\r
\r
* Insert clean floppy without bad sectors to drive.\r
* Write to it `kolibri.img` image with any available methods:\r
\r
  * (if you have already loaded KolibriOS by any method) run the program\r
    `rdsave` and select the variant corresponding to floppy;\r
\r
  * (for DOS and Windows) run subjoined install.bat;\r
\r
  * with program WinImage or its analogue (e.g. DiskExplorer);\r
\r
  * (for Linux) set "executable" attribute to subjoined script install.sh\r
    and run it.\r
\r
Now you can boot from floppy (keep it in drive, reboot, set in BIOS option of\r
floppy booting).\r
\r
\r
### Install to hard disk\r
\r
There exist several loaders from hard disk. All are oriented on DOS and Windows\r
users. Also standard Linux-loader GRUB can be used. All methods work with file\r
`kolibri.img`. If you already have old version of KolibriOS installed, simply\r
replace `kolibri.img` to the new one. If you have booted from LiveCD, which does\r
not contain the file `kolibri.img`, KolibriOS can create it independently. To do\r
this, run the program `rdsave`, enter the file name for saving and select the\r
corresponding variant. Of course, in this case KolibriOS must be able to write\r
to file system of selected partitions. Currently this means that only FAT and\r
EXT2 volumes are ok.\r
\r
* Most of all features has the loader mtldr (author - Diamond) - works with\r
  DOS/Win95/98/NT/2k/XP/Vista, supports FAT32 and NTFS, has installer, can be\r
  installed to any folder on disk.\r
\r
  To install, simply run file HD_load\mtldr_install.exe and select image file.\r
  Apropos, by this way you can install several images. There is also variant of\r
  install by hand - for those who want to know what installer does: directions\r
  in `HD_load\mtldr`.\r
\r
* There is also the loader MeOSLoad (author - Trans, expanded by Mario79) -\r
  works with DOS/Win95/98, supports FAT32. It is placed with the instruction\r
  to the folder `HD_load\MeOSLoad`.\r
\r
* Moreover, there exists a program which allows to load KolibriOS directly from\r
  Windows 95/98/Me (of course, unloading it) - `9x2klbr` (author - Diamond),\r
  supports FAT32 and NTFS.\r
\r
* Usage of the loader GRUB. Place the file `memdisk` to the folder `boot`\r
  or to the partition used for KolibriOS.\r
\r
  a) For GRUB2, in the folder `/etc/grub.d` add to one of files next lines:\r
\r
  ```\r
  menuentry 'KolibriOS' {\r
          linux16 (hd[Hard disk number],[partition number])[path]/memdisk\r
          initrd16 (hd[Hard disk number],[partition number])[path]/kolibri.img\r
  }\r
  ```\r
  example:\r
\r
  ```\r
  menuentry 'KolibriOS' {\r
          linux16 (hd0,msdos1)/boot/memdisk\r
          initrd16 (hd0,msdos1)/boot/kolibri.img\r
  }\r
  ```\r
  then, run in terminal `sudo update-grub`.\r
\r
  b) For old GRUB, add to the configuration file `menu.lst` next lines:\r
\r
  ```\r
  title KolibriOS\r
  kernel (hd[Hard disk number],[partition number])[path]/memdisk\r
  initrd (hd[Hard disk number],[partition number])[path]/kolibri.img\r
  ```\r
  Remember that numeration in GRUB starts from 0. Example:\r
\r
  ```\r
  title KolibriOS\r
  kernel (hd0,0)/boot/memdisk\r
  initrd (hd0,3)/kolibri/kolibri.img\r
  ```\r
\r
\r
### Install to USB flash drive\r
\r
The special loader for FAT32-volumes has been written. It and its installer to\r
flash drive can be found in the directory `HD_load\USB_Boot`.\r
\r
Despite the fact that the installer from the previous step is recommended, you \r
may also use Rufus https://rufus.ie to write Kolibri ISO-image on the USB flash.\r
\r
For not-FAT32 drives you may use article placed in the directory\r
`HD_load\USB_Boot_old`.\r
\r
\r
### Install to CD and DVD\r
\r
There exists special LiveCD-version of KolibriOS, which contains in addition to\r
standard things some 'heavy' (in KolibriOS standards) programs: the ported\r
emulator DosBox, videoplayer Fplay, PDF reader, games like Quake, DOOM, Tyrian\r
and Wolfenstain3D, etc.\r
\r
You can also create bootable CD or DVD on the base of `kolibri.img`, adding\r
anything what you want, in the mode of floppy emulation. The appropriate actions\r
are determined by used CD/DVD write program (focus on words such as 'boot floppy\r
emulation').\r
\r
\r
Installation: UEFI mode\r
-----------------------\r
\r
UEFI support is still in beta. Be ready to face issues and report them.\r
\r
### Install to hard disk\r
\r
* To boot KolibriOS from HDD these four files are needed:\r
\r
  * `uefi4kos`: UEFI-specific loader for KolibriOS, shipped as `bootx64.efi` and\r
    `bootia32.efi` binaries. Choose one of these `boot*.efi` images to match the\r
    architecture of your machine's UEFI firmware. Use `bootx64.efi` if unsure.\r
  * `kolibri.img`: a RAM disk image.\r
  * `kolibri.krn`: KolibriOS kernel compiled without BIOS-related legacy stuff.\r
  * `kolibri.ini`: a configuration file. It is used to e.g. set screen\r
    resolution.\r
\r
\r
* If you have any UEFI-aware OS installed on your HDD, then there already is a\r
  so called EFI system partition (ESP) on it. If your HDD is not partitioned\r
  yet, you have to first create a GUID partition table (GPT) on it and then\r
  create mentioned EFI system partition formatted as FAT32.\r
\r
* Make a directory `/efi/kolibrios` on the ESP.\r
\r
* Copy all the `kolibri.???` files mentioned above to that directory.\r
\r
* If KolibriOS is the only OS to be loaded from that HDD, make a directory\r
  `/efi/boot` and copy the chosen `boot*.efi` loader there.\r
\r
* If there is some other OS already installed on the HDD, put `boot*.efi` file\r
  to `/efi/kolibrios` directory and then setup the boot loader of the installed\r
  OS to boot KolibriOS.\r
\r
  For example, for GRUB2 (nowadays also known as just GRUB, not GRUB1 or\r
  GRUB-legacy) follow these three steps:\r
\r
  1. Append file `/etc/grub.d/42_custom` with a new menu entry.\r
\r
     ```\r
     menuentry "KolibriOS" {\r
             insmod part_gpt\r
             insmod fat\r
             insmod chain\r
             chainloader /EFI/kolibrios/bootx64.efi\r
     }\r
     ```\r
\r
  2. Locate GRUB config file in your system, namely `grub.cfg`. It might be in\r
     `/boot/grub/`.\r
\r
  3. Update `grub.cfg` with a command like below.\r
     ```\r
     sudo grub-mkconfig -o /boot/grub/grub.cfg\r
     ```\r
\r
\r
### Install to USB flash drive\r
\r
* If you prefer to keep all the data on the USB drive, follow the\r
  steps above for hard disks.\r
\r
* If, instead, you are okay to lose all the data on the USB drive, use\r
  `kolibri.raw` image. It is ready to be directly written to the flash drive.\r
\r
  Linux users can write the image with standard utilities `cat` or `dd`.\r
\r
  Windows users can use [Rawwrite32] or [Rufus].\r
\r
[Rawwrite32]: https://www.netbsd.org/~martin/rawrite32/\r
[Rufus]: https://rufus.ie\r