From: Davin McCall <davmac@davmac.org>
Date: Sat, 18 Jun 2016 16:51:10 +0000 (+0100)
Subject: Small documentation updates.
X-Git-Tag: v0.03~11
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=ee198c7d980b440baf3f6b7f9109c0cdeb796b1c;p=oweals%2Fdinit.git

Small documentation updates.
---

diff --git a/BUILD b/BUILD
new file mode 100644
index 0000000..2efbc57
--- /dev/null
+++ b/BUILD
@@ -0,0 +1,20 @@
+Building Dinit
+=-=-=-=-=-=-=-
+
+Buildingn Dinit should be a straight-forward process. It requires GNU make.
+
+Edit the "mconfig" file to choose appropriate values for the configuration variables defined
+within. In particular:
+
+  CXX : should be set to the name of the C++ compiler (and linker)
+  CXXOPTS :  are options passed to the compiler during compilation
+  EXTRA_LIBS : are any extra libraries required for linking; should not normally be needed.
+
+Defaults for Linux and OpenBSD are provided. Note that the "eg++" package must be installed
+on OpenBSD as the default "g++" compiler is too old.
+
+Then, change into the "src" directory, and run "make" (or "gmake" if the system make is not
+GNU make):
+
+    cd src
+    make
diff --git a/README b/README
index ce5362b..77d7f14 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 Dinit
 -----
-v0.1 (pre-release)
+v0.02 (pre-release)
 
 
 What is it?
@@ -20,7 +20,9 @@ first "rolling back" all dependent services (which it will later re-start,
 if configured to do so).
 
 Dinit is designed to work on POSIXy operating systems such as Linux and
-OpenBSD. It is written in C++ and uses the "libev" event handling library.
+OpenBSD. It is written in C++ and uses the "Dasynq" event handling library,
+which was written especially to support Dinit.
+
 Development goals include clean design, robustness, portability, and
 avoiding feature bloat (whilst still handling a variety of use cases).
 
@@ -31,6 +33,8 @@ license can be found in the LICENSE file.
 
 Dinit was written by Davin McCall <davmac@davmac.org>.
 
+See BUILD for information on how to build Dinit.
+
 
 Introduction to services
 =-=-=-=-=-=-=-=-=-=-=-=-
@@ -92,7 +96,7 @@ is also considered active.
 If a service stops and becomes inactive (i.e. it is not explicitly marked
 active and has no active dependents) then any services it depends on will
 also be marked inactive and stopped unless they have other active
-dependents (or are explicitly active).
+dependents, or were explicitly started and marked active.
 
 What this means is that, in general, starting an (inactive, stopped)
 service and then stopping it will return the system to its prior state -