github.com/rck/u-root@v0.0.0-20180106144920-7eb602e381bb/docs/index.html (about) 1 <!DOCTYPE html> 2 <html lang="en"> 3 <head> 4 <meta charset="utf-8"> 5 <meta http-equiv="X-UA-Compatible" content="IE=edge"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 7 <meta name="description" content="u-root: A Go-based, Firmware Embeddable Root File System with On-demand Compilation"> 8 9 <link rel="canonical" href="http://u-root.tk/"> 10 <link rel="shortcut icon" href="./img/favicon.png"> 11 12 13 <title>u-root</title> 14 15 <link href="./css/bootstrap-custom.min.css" rel="stylesheet"> 16 <link href="./css/font-awesome-4.5.0.css" rel="stylesheet"> 17 <link href="./css/base.css" rel="stylesheet"> 18 <link rel="stylesheet" href="./css/highlight.css"> 19 20 <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> 21 <!--[if lt IE 9]> 22 <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script> 23 <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script> 24 <![endif]--> 25 26 27 </head> 28 29 <body class="homepage"> 30 31 <div class="navbar navbar-default navbar-fixed-top" role="navigation"> 32 <div class="container"> 33 34 <!-- Collapsed navigation --> 35 <div class="navbar-header"> 36 37 <!-- Expander button --> 38 <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> 39 <span class="sr-only">Toggle navigation</span> 40 <span class="icon-bar"></span> 41 <span class="icon-bar"></span> 42 <span class="icon-bar"></span> 43 </button> 44 45 46 <!-- Main title --> 47 <a class="navbar-brand" href=".">u-root</a> 48 </div> 49 50 <!-- Expanded navigation --> 51 <div class="navbar-collapse collapse"> 52 53 54 <ul class="nav navbar-nav navbar-right"> 55 <li> 56 <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal"> 57 <i class="fa fa-search"></i> Search 58 </a> 59 </li> 60 61 62 <li> 63 <a href="https://github.com/u-root/u-root"> 64 65 <i class="fa fa-github"></i> 66 67 GitHub 68 </a> 69 </li> 70 71 </ul> 72 </div> 73 </div> 74 </div> 75 76 <div class="container"> 77 78 <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary"> 79 <ul class="nav bs-sidenav"> 80 81 <li class="main active"><a href="#u-root">u-root</a></li> 82 83 <li><a href="#setup">Setup</a></li> 84 85 <li><a href="#submitting-changes">Submitting Changes</a></li> 86 87 <li><a href="#faqs">FAQs</a></li> 88 89 <li><a href="#community">Community</a></li> 90 91 <li><a href="#contributors">Contributors</a></li> 92 93 94 </ul> 95 </div></div> 96 <div class="col-md-9" role="main"> 97 98 <p><center> 99 <h3>Behold the Gopher!</h3> 100 <img src="img/u-root-logo.png" alt="u-root logo" width=300 /> 101 </center></p> 102 <h1 id="u-root">u-root</h1> 103 <p>u-root is an embeddable root file system intended to be placed in a flash device 104 as part of the firmware image, along with a Linux kernel. Unlike most embedded 105 root file systems, which consist of large binaries, u-root only has five: an 106 init program and four Go compiler binaries.</p> 107 <h2 id="setup">Setup</h2> 108 <p>On an Ubuntu system, install prerequisites and ensure Go is at least version 1.7:</p> 109 <pre><code class="sh">sudo apt-get install git golang build-essential 110 go version 111 </code></pre> 112 113 <p>Set your <code>GOPATH</code>:</p> 114 <pre><code class="sh">export GOPATH="$HOME/go" 115 </code></pre> 116 117 <p>Clone u-root:</p> 118 <pre><code class="sh">go get github.com/u-root/u-root 119 cd "$GOPATH/src/github.com/u-root/u-root" 120 </code></pre> 121 122 <p>Generate an initramfs of all u-root Go tools:</p> 123 <pre><code class="sh">go run u-root.go -o initramfs.cpio 124 </code></pre> 125 126 <p>You can use this initramfs with your favorite Linux kernel in QEMU to try it 127 out.</p> 128 <p>More instructions can be found in the repo's 129 <a href="https://github.com/u-root/u-root/blob/master/README.md">README.md</a>.</p> 130 <h2 id="submitting-changes">Submitting Changes</h2> 131 <p>We use <a href="https://github.com/u-root/u-root/pulls">GitHub Pull Requests</a> for code 132 review. Pull requests must receive one approval and pass CI before being merged.</p> 133 <p>For convenience, it is recommended to use this pre-commit hook:</p> 134 <pre><code class="sh">ln -s -f ../../scripts/pre-commit .git/hooks/pre-commit 135 </code></pre> 136 137 <h2 id="faqs">FAQs</h2> 138 <h3 id="so-why-u-root">So, why "u-root"?</h3> 139 <p>It's to reflect a universal root, you can mount on every 140 local and get a userland portable (it's a goal).</p> 141 <h3 id="any-publications">Any publications?</h3> 142 <ul> 143 <li><a href="https://www.usenix.org/system/files/conference/atc15/atc15-paper-minnich.pdf">USENIX 2015 ATC Paper</a></li> 144 <li><a href="https://www.usenix.org/conference/atc15/technical-session/presentation/minnich">USENIX 2015 ATC Talk</a></li> 145 <li>Related: Embedded Linux Conference 2017 LinuxBoot Talk (<a href="https://www.youtube.com/watch?v=iffTJ1vPCSo">YouTube video</a>, <a href="https://schd.ws/hosted_files/osseu17/84/Replace%20UEFI%20with%20Linux.pdf">slides</a>)</li> 146 </ul> 147 <h2 id="community">Community</h2> 148 <ul> 149 <li><a href="https://groups.google.com/forum/#!forum/u-root">Join the mailing list</a></li> 150 <li><a href="https://u-root.slack.com/">Join slack</a> (Get an invite <a href="http://slack.u-root.com">here</a>.)</li> 151 <li><a href="https://github.com/u-root/u-root/blob/master/roadmap.md">Checkout the roadmap</a></li> 152 </ul> 153 <h2 id="contributors">Contributors</h2> 154 <ul> 155 <li><a href="https://github.com/rminnich">Ron Minnich</a></li> 156 <li><a href="https://github.com/mirtchovski">Andrey Mirtchovski</a></li> 157 <li><a href="https://github.com/rhiguita">Alexandre Beletti</a></li> 158 <li><a href="https://github.com/ryukinix">Manoel Machado</a></li> 159 <li><a href="https://github.com/rafaelcn">Rafael C. Nunes</a></li> 160 <li><a href="https://github.com/mathgamain">Matheus Pinto Rodrigues</a></li> 161 <li><a href="https://github.com/GanShun">Gan Shun Lim</a></li> 162 <li><a href="https://github.com/rjoleary">Ryan O'Leary</a></li> 163 <li><a href="https://github.com/hugelgupf">Chris Koch</a></li> 164 </ul></div> 165 166 </div> 167 168 <footer class="col-md-12"> 169 <hr> 170 171 <p>Copyright 2016-2017 The u-root team</p> 172 173 <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p> 174 </footer> 175 176 <script src="./js/jquery-1.10.2.min.js"></script> 177 <script src="./js/bootstrap-3.0.3.min.js"></script> 178 <script src="./js/highlight.pack.js"></script> 179 <script>var base_url = '.';</script> 180 <script data-main="./mkdocs/js/search.js" src="./mkdocs/js/require.js"></script> 181 <script src="./js/base.js"></script> 182 183 <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true"> 184 <div class="modal-dialog"> 185 <div class="modal-content"> 186 <div class="modal-header"> 187 <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button> 188 <h4 class="modal-title" id="exampleModalLabel">Search</h4> 189 </div> 190 <div class="modal-body"> 191 <p> 192 From here you can search these documents. Enter 193 your search terms below. 194 </p> 195 <form role="form"> 196 <div class="form-group"> 197 <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query"> 198 </div> 199 </form> 200 <div id="mkdocs-search-results"></div> 201 </div> 202 <div class="modal-footer"> 203 </div> 204 </div> 205 </div> 206 </div> 207 208 </body> 209 </html> 210 211 <!-- 212 MkDocs version : 0.15.3 213 Build Date UTC : 2017-11-20 08:00:19 214 -->