summary refs log tree commit diff
path: root/Documentation/installation/getting-spectrum.adoc
diff options
context:
space:
mode:
authorJenni Nikolaenko <evgeniia.nikolaenko@unikie.com>2022-11-08 16:52:28 +0200
committerAlyssa Ross <alyssa.ross@unikie.com>2022-11-08 17:56:20 +0000
commit0a2a5c6d34eb94d18f9cc6a5076ed5d97f7e0715 (patch)
tree91198c396b0646e5ec15bcb8acda85ae3705290e /Documentation/installation/getting-spectrum.adoc
parentf3247c14cb525991e701fb3f87ac5d5ab0587690 (diff)
downloadspectrum-0a2a5c6d34eb94d18f9cc6a5076ed5d97f7e0715.tar
spectrum-0a2a5c6d34eb94d18f9cc6a5076ed5d97f7e0715.tar.gz
spectrum-0a2a5c6d34eb94d18f9cc6a5076ed5d97f7e0715.tar.bz2
spectrum-0a2a5c6d34eb94d18f9cc6a5076ed5d97f7e0715.tar.lz
spectrum-0a2a5c6d34eb94d18f9cc6a5076ed5d97f7e0715.tar.xz
spectrum-0a2a5c6d34eb94d18f9cc6a5076ed5d97f7e0715.tar.zst
spectrum-0a2a5c6d34eb94d18f9cc6a5076ed5d97f7e0715.zip
Docs: new structure
Create separate folders for new parent pages, update Introduction page,
remove a and the articles from titles, quick check text for simple english

Signed-off-by: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
Message-Id: <20221108145228.21188-1-evgeniia.nikolaenko@unikie.com>
Diffstat (limited to 'Documentation/installation/getting-spectrum.adoc')
-rw-r--r--Documentation/installation/getting-spectrum.adoc54
1 files changed, 54 insertions, 0 deletions
diff --git a/Documentation/installation/getting-spectrum.adoc b/Documentation/installation/getting-spectrum.adoc
new file mode 100644
index 0000000..392cab5
--- /dev/null
+++ b/Documentation/installation/getting-spectrum.adoc
@@ -0,0 +1,54 @@
+= Getting Spectrum
+:page-parent: Build and Run
+:page-nav_order: 2
+
+// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
+// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0
+
+To get Spectrum, you need to build it from source.  As long as you're
+running Linuxfootnote:[Building from other operating systems might
+work, but hasn't been tested.  Patches are welcome to support building
+from other operating systems, as long as they're not too invasive.]
+and have https://nixos.org/download.html[Nix] and https://git-scm.com/[git]
+installed, it's very easy to do.
+
+TIP: Before you start, consider setting up the
+xref:binary-cache.adoc[Spectrum binary cache], which will save you a
+lot of time waiting for builds.
+
+== Trying Spectrum
+
+If you want to try Spectrum out to get a feel for it, without
+installing it, you can run it in a development VM with some example
+applications.
+
+[source,shell]
+----
+git clone https://spectrum-os.org/git/spectrum
+git clone https://github.com/NixOS/nixpkgs
+git clone -b rootfs --reference nixpkgs \
+  https://spectrum-os.org/git/nixpkgs nixpkgs-spectrum
+cd spectrum/host/rootfs
+nix-shell -I nixpkgs=../../../nixpkgs-spectrum --run 'make run'
+----
+
+This builds just enough of Spectrum to try it out in a VM, but it will
+still take a very long time.
+
+== Building Installer
+
+[source,shell]
+----
+git clone https://spectrum-os.org/git/spectrum
+nix-build spectrum/img/combined \
+  -I nixpkgs=https://spectrum-os.org/git/nixpkgs/snapshot/nixpkgs-rootfs.tar.gz
+----
+
+If you haven't set up the xref:binary-cache.adoc[binary cache], this
+will take a very long time.  When it's done, a symbolic link named
+"result" will appear, pointing to a Spectrum USB installer image.
+
+CAUTION: Do not use Spectrum for anything important or sensitive as it is not
+yet suitable for real-world use.  Many important security properties are
+currently missing, and there is no procedure for updating to
+new versions—you have to reinstall the OS.