Add Clear Linux Project documentation

lathama · Jul 21, 2016 · dbe1941 · dbe1941
1 parent f4b4253
commit dbe1941
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/clearlinux/README-short.txt b/clearlinux/README-short.txt
@@ -0,0 +1 @@
+Official docker build of Clear Linux OS for Intel Architecture
diff --git a/clearlinux/content.md b/clearlinux/content.md
@@ -0,0 +1,18 @@
+# Clear Linux OS
+
+This serves as the official [Clear Linux OS](https://clearlinux.org) image.
+
+%%LOGO%%
+
+The `clearlinux:latest` tag will point to `clearlinux:base` which will track toward the latest release version of the distribution.
+
+This image contains the os-core and os-core-update bundles, the latter can be used to add additional Clear Linux OS components (see [here](https://clearlinux.org/documentation/swupdate_about_sw_update.html) for more details about swupd and [here](https://clearlinux.org/documentation/bundles_overview.html) for more information on bundles).
+
+The following Dockerfile will install the editors and dev-utils bundles on top of the base image
+
+```sh
+FROM clearlinux:base
+RUN swupd bundle-add editors dev-utils
+```
+
+Where editors contains the usual suspects for command line editors and dev-utils contains some handy development tools like strace, gdb and valgrind.
diff --git a/clearlinux/github-repo b/clearlinux/github-repo
@@ -0,0 +1 @@
+https://github.com/clearlinux/docker-brew-clearlinux
diff --git a/clearlinux/logo.png b/clearlinux/logo.png
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Official docker build of Clear Linux OS for Intel Architecture
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		https://github.com/clearlinux/docker-brew-clearlinux