Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
djphoenix committed May 4, 2019
1 parent 470d92f commit 8dfef91
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 36 deletions.
6 changes: 3 additions & 3 deletions docs/build.md
@@ -1,9 +1,9 @@
### Source download
* [GIT](https://en.wikipedia.org/wiki/Git_(software)): `git clone https://git.phoenix.dj/phoenix/phoenix-os/`
* [ZIP file](https://git.phoenix.dj/phoenix/phoenix-os/builds/artifacts/master/download?job=build) from master branch.
* [ZIP file](https://git.phoenix.dj/phoenix/phoenix-os/repository/archive.zip) from master branch.

### Build prerequisites
* [CLANG](https://clang.llvm.org/) 5
* [CLANG](https://clang.llvm.org/) 5 or later
* [GNU make](http://www.gnu.org/software/make/)

### Build on GNU/Linux
Expand All @@ -25,7 +25,7 @@ make all
# Install homebrew (if not installed)
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
# Install GIT, GIT-LFS, MAKE, CLANG 5
brew install git git-lfs make llvm@5
brew install git git-lfs make llvm
# Get source code
git clone https://git.phoenix.dj/phoenix/phoenix-os.git
# Build
Expand Down
34 changes: 2 additions & 32 deletions docs/run-pc.md
Expand Up @@ -7,6 +7,8 @@ For launch PhoeniX OS on PC you need to:
## CD
For launch from CD you need to create ISO image with bootloader and PhoeniX OS kernel, then build it to blank CD.

To make bootable ISO you may use `make iso` command in source directory (see [build](build.md) section).

For build ISO image you may use these tools:

* Linux
Expand All @@ -17,37 +19,5 @@ For build ISO image you may use these tools:
* [CDBurnerXP](https://cdburnerxp.se/?lang=en) ([documentation](https://cdburnerxp.se/help/Data/burn-iso) on official website)
* [Windows 7](http://windows.microsoft.com/en-us/windows7/burn-a-cd-or-dvd-from-an-iso-file) (or later) (documentation at http://windows.microsoft.com/)


### Prepare files
Download and extract archive of latest [SYSLINUX binaries](https://www.kernel.org/pub/linux/utils/boot/syslinux/syslinux-6.03.zip) from [Kernel.org](https://kernel.org/).

Create a folder on hard drive that contains:

1. `phoenixos` - PhoeniX OS kernel file
2. `isolinux.bin` from SYSLINUX archive (`bios/core/isolinux.bin`)
3. `ldlinux.c32` from SYSLINUX archive (`bios/com32/elflink/ldlinux/ldlinux.c32`)
4. `libcom32.c32` from SYSLINUX archive (`bios/com32/lib/libcom32.c32`)
5. `mboot.c32` from SYSLINUX archive (`bios/com32/mboot/mboot.c32`)
6. `isolinux.cfg` - isolinux [bootloader configuration](http://www.syslinux.org/wiki/index.php?title=Config) (text file) contains `default /mboot.c32 /phoenixos`

### Linux / Mac OS X
For creation of ISO image used `mkisofs` tool contained in `cdrtools` package. Install it with command:

* Mac OS X: `brew install cdrtools` ([Homebrew](http://brew.sh/) required)
* Linux (debian/ubuntu): `sudo apt-get install cdrtools`

Then (in terminal) switch working directory (`cd`) to folder that contains files from step "Prepare files" and run command

mkisofs -o ../phoenixos.iso -b isolinux.bin -c boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table .

In result, in parent folder, will be created file `phoenixos.iso` that you should write on CD.

### Windows
Download and install [`CDR-Tools`](http://cdrtoolswin.sourceforge.net/) ([direct download link](http://sourceforge.net/projects/cdrtoolswin/files/1.0/Binaries/CDR-Tools.exe/download)).

Place [this file](https://git.phoenix.dj/snippets/3) into folder that contains files from step "Prepare files" and run it.

In result, in parent folder, will be created file `phoenixos.iso` that you should write on CD.

## USB
TODO
2 changes: 1 addition & 1 deletion docs/run-vm.md
Expand Up @@ -6,4 +6,4 @@ In Virtual Machine configuration select ISO image as bootable CD.
### [QEMU](http://wiki.qemu.org/Main_Page)
Get binary kernel [from CI](https://git.phoenix.dj/phoenix/phoenix-os/builds/artifacts/master/download?job=build) or [build it from source](build.md)

Launch QEMU with `-kernel phoenixos` option.
Launch QEMU with `-kernel phoenixos` option (or use `make launch` or `make launch-efi` command in source directory, see [build it from source](build) section for details)

0 comments on commit 8dfef91

Please sign in to comment.