10/19/23
This commit is contained in:
parent
b8a1522efa
commit
82c02bb697
@ -22,6 +22,8 @@
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="hero-image">
|
||||
</div>
|
||||
<div class="main">
|
||||
<h2>About Everest</h2>
|
||||
<p>Everest Linux is a source based Linux meta-distribution, with a focus on simplicity and flexibility.</p>
|
||||
|
||||
53
css/nord.css
53
css/nord.css
@ -12,7 +12,7 @@
|
||||
/* Sidebar menu */
|
||||
.sidenav {
|
||||
height: 100%;
|
||||
width: 160px;
|
||||
width: 200px;
|
||||
position: fixed;
|
||||
z-index: 1;
|
||||
top: 0;
|
||||
@ -41,7 +41,7 @@ html {
|
||||
}
|
||||
|
||||
.main {
|
||||
margin-left: 160px;
|
||||
margin-left: 200px;
|
||||
padding: 0px 10px;
|
||||
background-color: #3B4252;
|
||||
}
|
||||
@ -147,6 +147,17 @@ wikihead {
|
||||
color: #D08770;
|
||||
}
|
||||
|
||||
bigcodehead {
|
||||
background-color: #2E3440;
|
||||
border-left-style: solid;
|
||||
border-left-color: #ECEFF4;
|
||||
border-width: 4px;
|
||||
border-radius: 2px;
|
||||
padding: 4px;
|
||||
width: 50%;
|
||||
color: #ECEFF4;
|
||||
}
|
||||
|
||||
@media screen and (max-height: 450px) {
|
||||
.sidenav {padding-top: 15px;}
|
||||
.sidenav a{font-size: 18px;}
|
||||
@ -168,6 +179,17 @@ code {
|
||||
color: #ECEFF4;
|
||||
}
|
||||
|
||||
.bigcode {
|
||||
font-family: monospace;
|
||||
background-color: #2E3440;
|
||||
border-left-style: solid;
|
||||
border-left-width: 4px;
|
||||
border-radius: 2px;
|
||||
padding: 6px;
|
||||
border-color: #ECEFF4;
|
||||
width: 50%;
|
||||
}
|
||||
|
||||
cil {
|
||||
font-family: monospace;
|
||||
background-color: #2E3440;
|
||||
@ -275,3 +297,30 @@ footer {
|
||||
img {
|
||||
padding: 8px;
|
||||
}
|
||||
|
||||
/* */
|
||||
|
||||
body, html {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
/* The hero image */
|
||||
.hero-image {
|
||||
background-image: linear-gradient(rgba(0, 0, 0, 0.5), rgba(0, 0, 0, 0.5)), url("../img/banner.jpg");
|
||||
|
||||
height: 55%;
|
||||
|
||||
background-position: 50% 30%;
|
||||
background-repeat: no-repeat;
|
||||
background-size: cover;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.hero-text {
|
||||
text-align: center;
|
||||
position: absolute;
|
||||
top: 50%;
|
||||
left: 50%;
|
||||
transform: translate(-50%, -50%);
|
||||
color: white;
|
||||
}
|
||||
|
||||
122
docs/dev-docs.html
Normal file
122
docs/dev-docs.html
Normal file
@ -0,0 +1,122 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Everest Linux - Docs</title>
|
||||
<link type="text/css" rel="stylesheet" href="../css/nord.css"/>
|
||||
</head>
|
||||
<body>
|
||||
<!-- Navbar -->
|
||||
<div class="sidenav">
|
||||
<img src="../img/everest-nord.svg" alt="everest-logo">
|
||||
<a href="../index.html">Home</a>
|
||||
<a href="../about.html">About</a>
|
||||
<a href="../install.html">Install</a>
|
||||
<a href="../packages.html">Packages</a>
|
||||
<a href="../download.html">Downloads</a>
|
||||
<a href="home.html">Docs</a>
|
||||
<a href="../errata.html">Errata</a>
|
||||
<a href="https://git.everestlinux.org">Git ↗</a>
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="main">
|
||||
<button onclick="window.location.href='home.html';">
|
||||
Back to home
|
||||
</button>
|
||||
<h2>Developer Documentation</h2>
|
||||
<p>This page contains developer-specific documentation.</p>
|
||||
<h2>1 - Coding Style</h2>
|
||||
<p><strong>1.1</strong> File Structure</p>
|
||||
<p>Files should follow this format:<p>
|
||||
<ul>
|
||||
<li>Header comment, including program name and LICENSE</li>
|
||||
<li>Headers</li>
|
||||
<li>Macros</li>
|
||||
<li>Types</li>
|
||||
<li>Global variables</li>
|
||||
<li>Functions</li>
|
||||
<li><cil>main</cil> (if applicable)</li>
|
||||
</ul>
|
||||
<p>Note that function declarations should be defined in a separate header, ex:</p>
|
||||
<p><cil>#include "project_name.h"</cil></p>
|
||||
<p>Indentations should be a single tab and be equal to 8 characters for better readability.</p>
|
||||
<p><strong>1.2</strong> Functions</p>
|
||||
<p>Functions should have their return type on one line, their name and parameters one line down, and the bracket one line under the name and arguments.</p>
|
||||
<p>Example:</p>
|
||||
<bigcodehead><strong>CODE:</strong> Proper function formatting in C</bigcodehead>
|
||||
<div class="bigcode">
|
||||
<p>static void</p>
|
||||
<p>usage(int argc, char *argv[])
|
||||
<p>{</p>
|
||||
<p> printf("usage: %s [-a] [-b]\n", argv[0]);</p>
|
||||
<p>}</p>
|
||||
</div>
|
||||
<p></p>
|
||||
<p><strong>1.3</strong> Example Program</p>
|
||||
<fhead><strong>FILE:</strong> prog.c</fhead>
|
||||
<div class="file">
|
||||
<p>#include <stdio.h></p>
|
||||
<p> </p>
|
||||
<p>#include "prog.h"</p>
|
||||
<p> </p>
|
||||
<p>void</p>
|
||||
<p>hello()</p>
|
||||
<p>{</p>
|
||||
<p> printf("hello\n");
|
||||
<p>}</p>
|
||||
<p> </p>
|
||||
<p>int</p>
|
||||
<p>main()</p>
|
||||
<p>{</p>
|
||||
<p> hello();
|
||||
<p>}</p>
|
||||
</div>
|
||||
<p></p>
|
||||
<fhead><strong>FILE:</strong> prog.h</fhead>
|
||||
<div class="file">
|
||||
<p>#ifndef PROG_H_</p>
|
||||
<p>#define PROG_H_</p>
|
||||
<p> </p>
|
||||
<p>void hello();</p>
|
||||
<p> <p>
|
||||
<p>#endif</p>
|
||||
</div>
|
||||
<h2>2 - Licensing</h2>
|
||||
<p><strong>2.1</strong> Disclaimer</p>
|
||||
<warnhead><strong>WARNING:</strong></warnhead>
|
||||
<div class="warning">
|
||||
<p>This is not legal advice. If you are in doubt with licensing, please contact your lawyer.</p>
|
||||
</div>
|
||||
<p><strong>2.2</strong> Preferred Licenses</p>
|
||||
<p>For all projects officially released under Everest, the GNU GPL family of licenses is preferred. It provides compatibility with all other existing Everest projects.</p>
|
||||
<p>Most programs should be licensed under the standard GPL. For libraries, you might want to choose the LGPL, if you want to allow linking within proprietary programs. For web applications, always choose the AGPL.</p>
|
||||
<p><strong>2.3</strong> Other Licenses</p>
|
||||
<p>If you wish to use a non-GPL license for your project, that is perfectly permissible.</p>
|
||||
<p>Before releasing your program, we ask that you add the following disclaimer to your README:</p>
|
||||
<fhead><strong>FILE:</strong> README</fhead>
|
||||
<div class="file">
|
||||
<p>LICENSING DISCLAIMER:</p>
|
||||
<p>This program is licensed under (LICENSE), and as such may be incompatible with other GPL-licensed Everest programs.</p>
|
||||
<p>Please contact the program's maintainer if you have questions.</p>
|
||||
</div>
|
||||
<p>If you are an Everest developer and host a project on our Git server, but do not want it associated with Everest, please submit an electronically signed form stating the following:</p>
|
||||
<fhead><strong>FILE:</strong> WAIVER</fhead>
|
||||
<div class="file">
|
||||
<p>Everest Linux Development Group hereby relinquishes all claims of ownership on program "foo" to developer "bar".
|
||||
<p>Electronically signed by Foobar on 1/1/2024</p>
|
||||
<p>Electronically signed by Everest Linux head developer on 1/1/2024</p>
|
||||
</div>
|
||||
<p><strong>2.3</strong> Proprietary Licenses</p>
|
||||
<p>Programs hosted on our Git servers are never to be released under proprietary licenses.</p>
|
||||
<p>There will be no further discussion.</p>
|
||||
</div>
|
||||
<footer>
|
||||
<p>Page last updated MM/DD/YY @ HH:MM</p>
|
||||
<p>Page licensed under GNU Free Documentation License 1.3 or later</p>
|
||||
<p>--------------------</p>
|
||||
<p>Copyright (C) 2021-2023 Everest Linux</p>
|
||||
<p>Linux (R) is a registered trademark of Linus Torvalds.</p>
|
||||
<p>Everest Linux is provided AS IS, WITHOUT WARRANTY.</p>
|
||||
</footer>
|
||||
@ -23,7 +23,7 @@
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="main">
|
||||
<h2>Docs</h2>
|
||||
<h2>Documentation</h2>
|
||||
<p><strong>Welcome to the Everest Linux documentation homepage!</strong></p>
|
||||
<p>Pages listed here are frequently updated. If you wish to make a correction, or submit a new page, please contact me at liamwaldron@everestlinux.org.</p>
|
||||
<script>
|
||||
@ -47,6 +47,7 @@
|
||||
</script>
|
||||
<input type="text" id="myInput" onKeyup="myFunction()" placeholder="Search documentation...">
|
||||
<ul id="myUL">
|
||||
<li><a href="dev-docs.html">Developer Documentation</a></li>
|
||||
<li><a href="general-recommendations.html">General Recommendations</a></li>
|
||||
<li><a href="intro-to-glacier.html">Introduction to Glacier</a></li>
|
||||
<li><a href="musl-or-glibc.html">musl or glibc?</a></li>
|
||||
|
||||
@ -22,6 +22,8 @@
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="hero-image">
|
||||
</div>
|
||||
<div class="main">
|
||||
<h2>Download Everest</h2>
|
||||
<p>Most users will want to get the most recent release. If for some reason you require an older release, it may be in the release archive, which contains all deprecated releases.</p>
|
||||
|
||||
@ -22,6 +22,8 @@
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="hero-image">
|
||||
</div>
|
||||
<div class="main">
|
||||
<h2>Errata</h2>
|
||||
<p>This page will be periodically updated with security advisories, and instructions for fixing them.</p>
|
||||
|
||||
BIN
img/banner.jpg
Normal file
BIN
img/banner.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.0 MiB |
@ -22,6 +22,8 @@
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="hero-image">
|
||||
</div>
|
||||
<div class="main">
|
||||
<h2>Everest Linux</h2>
|
||||
<p>A highly flexible, general purpose meta-distribution, built off of the monolithic Linux kernel and Glacier package manager.</p>
|
||||
|
||||
@ -22,6 +22,8 @@
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="hero-image">
|
||||
</div>
|
||||
<div class="main">
|
||||
<h2>Installation Handbook</h2>
|
||||
<p>This guide is the official installation handbook for Everest Linux.</p>
|
||||
@ -126,7 +128,7 @@
|
||||
<p>Create remaining directories on /usr with mkusrskel:</p>
|
||||
<code>(root)# mkusrskel -d /mnt/everest/usr</code>
|
||||
<h2>Downloading a system image</h2>
|
||||
<p>An Everest system image provides an incomplete root filesystem which users can build a system off of. Users should be careful of which image they choose, as switching in the future is trivial, time consuming, and requires rebuilding a lot of packages.</p>
|
||||
<p>An Everest system image provides an incomplete root filesystem which users can build a system off of. Users should be careful of which image they choose, as switching in the future is arduous, time consuming, and requires rebuilding a lot of packages.</p>
|
||||
<p>It's a lot better to get it right the first time, rather than trying to get it right later.</p>
|
||||
<p>Do some thorough planning to ensure you get the right system image. For instance, ask yourself a few questions, such as:</p>
|
||||
<ol>
|
||||
|
||||
@ -21,6 +21,8 @@
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="hero-image">
|
||||
</div>
|
||||
<div class="main">
|
||||
<h2>Package Database</h2>
|
||||
<p>This page contains links to multiple Glacier package databases.</p>
|
||||
|
||||
@ -21,6 +21,8 @@
|
||||
</div>
|
||||
|
||||
<!-- Rest of page -->
|
||||
<div class="hero-image">
|
||||
</div>
|
||||
<div class="main">
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user