Update README and LICENSE; prepare for public visibility.

1 files changed, 78 insertions, 17 deletions

diff --git a/README b/README
index 7b1003b..7bf45e4 100644
--- a/README
+++ b/README
@@ -1,36 +1,58 @@
-To create black- and white- versions of logo:
+overview
+--------
 
-  $ cd assets/images
-  $ ./polyguin.sh
+This is the source code for https://www.adelielinux.org/.
 
-To generate HTML bundle for upload to web server:
+We make heavy use of Docker containers to render images and sources.
+
+
+building
+--------
+
+To generate the 'html/' web root directory for upload to web server:
 
   $ make site
 
-Upload html.tgz to the server and unpack, then delete html.tgz.
 
-Imagemagick is required to convert the PSD files into .webm (or other) formats.
+installing
+----------
+
+It is anticipated that the 'html/' directory is served in-place
+and that this repository resides on the web server, has all of the
+required dependencies, and is updated periodically.
+
+If this is not the case, please compress/transfer 'html/' to the
+appropriate web server. You will need to perform updates manually.
+
+
+themes
+------
+
+A ThemeForest theme called "Mono" by FlaTheme is used as a base.
 
 2021-07-22 NOTICE:
 
-  * The theme.css file is manually modified. Awaiting theme author to provide valid source files.
+  * The theme.css file must be handled carefully (see below).
 
   * The following changes have been made from original:
 
       $ grep -rl AAAAAA assets/ | while read k; do sed -i ${k} -e 's/AAAAAA/DDDDDD/g'; done
       $ grep -rl 7C7C7C assets/ | while read k; do sed -i ${k} -e 's/7C7C7C/333333/g'; done
 
-Manual steps to do CSS processing:
 
-# Adélie SCSS Preprocessor
+scss preprocessor
+-----------------
+
+The base theme author "requires" use of a GUI-only SCSS preprocessor.
+We don't care for this, so we circumvent it with some heavy lifting.
 
-1. Throw CSS into `src/*`.
-2. Ensure that there is a top-level `src/theme.scss` file with imports.
-3. Run `npm i` to install dependencies.
-4. Run `npm build` to build to `out/`.
-5. Profit.
+These steps are performed to render the real CSS files:
 
-## Running
+ 1. Throw CSS into `src/*`.
+ 2. Ensure that there is a top-level `src/theme.scss` file with imports.
+ 3. Run `npm i` to install dependencies.
+ 4. Run `npm build` to build to `out/`.
+ 5. Profit.
 
 Targets may be run with `npm run <target>`.
 
@@ -41,6 +63,45 @@ Targets may be run with `npm run <target>`.
 | `list-supported` | List supported browsers |
 | `clean`          | Clean output directory  |
 
-## Notes
 
-- Fonts are downloaded and provided in `out/fonts/*`
+Fonts are downloaded (cached) and provided in `out/fonts/*`.
+
+Look at the script 'assets/css/compile.sh' for more information.
+
+Two output products are generated using vanilla SASS and then a custom
+Node.js project (leveraging PostCSS) called "adelie-css-compat":
+
+  * theme.css
+  * fonts/
+
+The latter project adapts the rendered CSS for older browsers.
+
+
+image generation
+----------------
+
+All images are derived from PSD files and/or template files. They are
+rendered in a number of formats and dimensions for use with various
+online and/or offline services.
+
+Currently the PSD source files do not contain history; this is due to
+an oversight and will be corrected. Large originals may not be found
+in this repository if their license prohibits unmodified distribution.
+
+
+license
+-------
+
+Copyright 2021 The Adélie Linux Project
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an "AS
+IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+express or implied. See the License for the specific language
+governing permissions and limitations under the License.