2021-02-07 03:52:57 +03:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Quick Start - nixflk docs< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
2021-02-12 08:09:02 +03:00
< link rel = "icon" href = "../../favicon.svg" >
2021-02-07 03:52:57 +03:00
2021-02-12 08:09:02 +03:00
< link rel = "shortcut icon" href = "../../favicon.png" >
2021-02-07 03:52:57 +03:00
2021-02-12 08:09:02 +03:00
< link rel = "stylesheet" href = "../../css/variables.css" >
< link rel = "stylesheet" href = "../../css/general.css" >
< link rel = "stylesheet" href = "../../css/chrome.css" >
2021-02-07 03:52:57 +03:00
2021-02-12 08:09:02 +03:00
< link rel = "stylesheet" href = "../../css/print.css" media = "print" >
2021-02-07 03:52:57 +03:00
<!-- Fonts -->
2021-02-12 08:09:02 +03:00
< link rel = "stylesheet" href = "../../FontAwesome/css/font-awesome.css" >
2021-02-07 03:52:57 +03:00
2021-02-12 08:09:02 +03:00
< link rel = "stylesheet" href = "../../fonts/fonts.css" >
2021-02-07 03:52:57 +03:00
<!-- Highlight.js Stylesheets -->
2021-02-12 08:09:02 +03:00
< link rel = "stylesheet" href = "../../highlight.css" >
< link rel = "stylesheet" href = "../../tomorrow-night.css" >
< link rel = "stylesheet" href = "../../ayu-highlight.css" >
2021-02-07 03:52:57 +03:00
<!-- Custom theme stylesheets -->
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
2021-02-12 08:09:02 +03:00
var path_to_root = "../../";
2021-02-07 03:52:57 +03:00
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2021-02-14 05:23:21 +03:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "../../doc/introduction.html" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../doc/start/index.html" class = "active" > < strong aria-hidden = "true" > 2.< / strong > Quick Start< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../../doc/start/iso.html" > < strong aria-hidden = "true" > 2.1.< / strong > ISO< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../doc/start/from-nixos.html" > < strong aria-hidden = "true" > 2.2.< / strong > From NixOS< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../../doc/layout.html" > < strong aria-hidden = "true" > 3.< / strong > Layout< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../../cachix/index.html" > < strong aria-hidden = "true" > 3.1.< / strong > Cachix< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../extern/index.html" > < strong aria-hidden = "true" > 3.2.< / strong > Extern< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../hosts/index.html" > < strong aria-hidden = "true" > 3.3.< / strong > Hosts< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../modules/index.html" > < strong aria-hidden = "true" > 3.4.< / strong > Modules< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../overlays/index.html" > < strong aria-hidden = "true" > 3.5.< / strong > Overlays< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../overrides/index.html" > < strong aria-hidden = "true" > 3.6.< / strong > Overrides< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../pkgs/index.html" > < strong aria-hidden = "true" > 3.7.< / strong > Packages< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../profiles/index.html" > < strong aria-hidden = "true" > 3.8.< / strong > Profiles< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../secrets/index.html" > < strong aria-hidden = "true" > 3.9.< / strong > Secrets< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../suites/index.html" > < strong aria-hidden = "true" > 3.10.< / strong > Suites< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../users/index.html" > < strong aria-hidden = "true" > 3.11.< / strong > Users< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../../doc/flk/index.html" > < strong aria-hidden = "true" > 4.< / strong > flk command< / a > < / li > < / ol >
2021-02-07 03:52:57 +03:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > nixflk docs< / h1 >
< div class = "right-buttons" >
2021-02-12 08:09:02 +03:00
< a href = "../../print.html" title = "Print this book" aria-label = "Print this book" >
2021-02-07 03:52:57 +03:00
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" name = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
< h1 > < a class = "header" href = "#quick-start" id = "quick-start" > Quick Start< / a > < / h1 >
< p > The only dependency is nix, so make sure you have it < a href = "https://nixos.org/manual/nix/stable/#sect-multi-user-installation" > installed< / a > .< / p >
< h2 > < a class = "header" href = "#get-the-template" id = "get-the-template" > Get the Template< / a > < / h2 >
2021-02-14 05:23:21 +03:00
< p > Here is a snippet that will get you the template without the git history:< / p >
2021-02-07 03:52:57 +03:00
< pre > < code class = "language-sh" > nix-shell https://github.com/nrdxp/nixflk/archive/core.tar.gz -A shell \
--run " flk get core"
cd flk
nix-shell
git init
git add .
git commit -m init
2021-02-07 07:48:01 +03:00
cachix use nrdxp
2021-02-07 03:52:57 +03:00
< / code > < / pre >
2021-02-14 05:23:21 +03:00
< p > This will place you in a new folder named < code > flk< / code > with git initialized, and a
nix-shell that provides all the dependencies, including the unstable nix
version required.< / p >
< p > In addition, the < a href = "../../cachix" > binary cache< / a > is added for faster deployment.< / p >
2021-02-07 03:52:57 +03:00
< blockquote >
2021-02-14 05:23:21 +03:00
< h5 > < a class = "header" href = "#notes" id = "notes" > < em > Notes:< / em > < / a > < / h5 >
< ul >
< li > You can change < code > core< / code > to < a href = "../introduction.html#community-profiles" > < code > community< / code > < / a >
in the call to < code > flk get< / code > < / li >
< li > Flakes ignore files that have not been added to git, so be sure to stage new
files before building the system.< / li >
< / ul >
2021-02-07 03:52:57 +03:00
< / blockquote >
< h2 > < a class = "header" href = "#next-steps" id = "next-steps" > Next Steps:< / a > < / h2 >
< ul >
< li > < a href = "./iso.html" > Make installable ISO< / a > < / li >
< li > < a href = "./from-nixos.html" > Already on NixOS< / a > < / li >
< / ul >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2021-02-12 08:09:02 +03:00
< a rel = "prev" href = "../../doc/introduction.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-02-07 03:52:57 +03:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-02-12 08:09:02 +03:00
< a rel = "next" href = "../../doc/start/iso.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-02-07 03:52:57 +03:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2021-02-12 08:09:02 +03:00
< a rel = "prev" href = "../../doc/introduction.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-02-07 03:52:57 +03:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-02-12 08:09:02 +03:00
< a rel = "next" href = "../../doc/start/iso.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-02-07 03:52:57 +03:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
2021-02-12 08:09:02 +03:00
< script src = "../../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-02-07 03:52:57 +03:00
2021-02-12 08:09:02 +03:00
< script src = "../../clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../book.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-02-07 03:52:57 +03:00
<!-- Custom JS scripts -->
< / body >
< / html >
