aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7d9f0ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+Common style for Carbs Linux projects
+=====================================
+
+This is an ongoing style project for sharing certain elements in-between
+projects. This currently includes only the stylesheet for the website, but
+others will be added for both `stagit` and GNU Texinfo manuals.
+
+
+Build
+-----
+
+Building the stylesheet requires `sassc`, which is packaged in Carbs Linux
+repositories. However, the generated stylesheets are also tracked in the
+repository, so there is no need to rebuild them unless you edit the `scss`
+files. You can run `make` after a change to rebuild these files.