Changeset 1a4ec93f in mainline for README.md

Timestamp:

2019-08-19T11:13:12Z (5 years ago)

Author:

Jiří Zárevúcky <zarevucky.jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

0a2c96c, 3e828ea

Parents:

3daa163

Message:

Update README

File:

• README.md (modified) (2 diffs)

README.md

@@ -51 +51 @@
 dependencies and try again.
 
-As an example, here are some of the packages you will need for Ubuntu 12.10 (may be out of date):
+As an example, here are some of the packages you will need for Ubuntu 16.04:
 
 ```
-$ sudo apt-get install build-essential libgmp-dev libmpfr-dev ppl-dev libmpc-dev zlib1g-dev texinfo libtinfo-dev xutils-dev flex bison
+$ sudo apt install build-essential wget texinfo flex bison dialog python-yaml genisoimage
 ```
 
@@ -70 +70 @@
 ### Configuring the build
 
-Go back to the source root of HelenOS and start the build process:
+Since the summer of 2019, HelenOS uses the Meson build system.
+Make sure you have a recent-enough version of Meson and Ninja.
+The safest bet is installing both using `pip3` tool.
+
+```sh
+$ pip3 install ninja
+$ pip3 install meson
+```
+
+Meson does not support in-tree builds, so you have to create a directory
+for your build. You can have as many build directories as you want, each with
+its own configuration. `cd` into your build directory and run `configure.sh`
+script which exists in the source root. `configure.sh` can be run with a profile
+name, to use one of the predefined profiles, or without arguments for interactive
+configuration.
+
+```sh
+$ git clone https://github.com/HelenOS/helenos.git
+$ mkdir -p build/amd64
+$ cd build/amd64
+$ ../../helenos/configure.sh amd64
+```
+
+Note: If you installed the toolchain to a custom directory, make sure `CROSS_PREFIX`
+environment variable is correctly set.
+
+Once configuration is finished, use `ninja` to build HelenOS.
+Invoking `ninja` without arguments builds all binaries and
+debug files, but not bootable image. This is because during
+development, most builds are incremental and only meant to check
+that code builds properly. In this case, the time-consuming process of
+creating a boot image is not useful and takes most time. This behavior
+might change in the future.
+
+In case you want to rebuild the bootable image, you must invoke
+`ninja image_path`. This also emits the name of the bootable image into the
+file `image_path` in build directory.
 
 ```
-$ cd ..
-$ make PROFILE=amd64
+$ ninja
+$ ninja image_path
 ```
 
 Now HelenOS should automatically start building.
 
-Note: If you installed the toolchain to a custom directory, make sure `CROSS_PREFIX`
-environment variable is correctly set.
-
 ### Running the OS
 
-When you get the command line back, there should be an `image.iso` file in the source
+When you get the command line back, there should be an `image.iso` file in the build
 root directory. If you have QEMU, you should be able to start HelenOS by running: