begin adding documentation
This commit is contained in:
parazyd
parent
d2089d9a20
commit
ad71825bc0
|
|
@ -0,0 +1,18 @@
|
||||||
|
all: clean html man
|
||||||
|
|
||||||
|
html:
|
||||||
|
@echo generating html...
|
||||||
|
@./nanodoc html
|
||||||
|
|
||||||
|
man:
|
||||||
|
@echo generating manpages...
|
||||||
|
@./nanodoc man
|
||||||
|
|
||||||
|
clean:
|
||||||
|
@echo cleaning...
|
||||||
|
@rm -rf html man nav.html
|
||||||
|
@sed -i -e 's:index.html">.*:html">NAME</a>:' static/head.html
|
||||||
|
@sed -i -e 's:Subtitle">.*:Subtitle">DESC</span>:' static/head.html
|
||||||
|
@sed -i -e 's:libdevuansdk-.*:libdevuansdk-VERSION</a>:' static/foot.html
|
||||||
|
|
||||||
|
.PHONY: all html man clean
|
||||||
|
|
@ -0,0 +1,48 @@
|
||||||
|
index
|
||||||
|
=====
|
||||||
|
|
||||||
|
`libdevuansdk` is a shell script library intended to unify the use and creation
|
||||||
|
of various functions spread throughout devuan's various sdks.
|
||||||
|
|
||||||
|
devuan's sdks are designed to be used interactively from a terminal, as
|
||||||
|
well as from shell scripts. libdevuansdk uses the functionality of the
|
||||||
|
[zuper](https://github.com/dyne/zuper) zsh library, but it does not include
|
||||||
|
it. you are required to include it in your sdk. however, `libdevuansdk`
|
||||||
|
requires the following packages to be installed:
|
||||||
|
|
||||||
|
```
|
||||||
|
zsh debootstrap sudo kpartx cgpt xz-utils
|
||||||
|
```
|
||||||
|
|
||||||
|
## notes
|
||||||
|
|
||||||
|
to support the development, you are welcome to open issues on problems and
|
||||||
|
bugs you encounter. open merge requests of patches or simply get involved
|
||||||
|
in other tasks evident on <https://git.devuan.org>
|
||||||
|
|
||||||
|
## acknowledgments
|
||||||
|
|
||||||
|
Devuan's SDK was originally conceived during a period of residency at the
|
||||||
|
Schumacher college in Dartington, UK. Greatly inspired by the laborious and
|
||||||
|
mindful atmosphere of its wonderful premises.
|
||||||
|
|
||||||
|
The Devuan SDK is Copyright (c) 2015-2016 by the Dyne.org Foundation
|
||||||
|
|
||||||
|
Devuan SDK components are designed, written and maintained by:
|
||||||
|
|
||||||
|
- Ivan J. <parazyd@dyne.org>
|
||||||
|
- Denis Roio <jaromil@dyne.org>
|
||||||
|
- Enzo Nicosia <katolaz@freaknet.org>
|
||||||
|
|
||||||
|
This source code is free software: you can redistribute it and/or modify it
|
||||||
|
under the terms of the GNU General Public License as published by the Free
|
||||||
|
Software Foundation, either version 3 of the License, or (at your option)
|
||||||
|
any later version.
|
||||||
|
|
||||||
|
This software is distributed in the hope that it will be useful, but
|
||||||
|
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||||
|
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||||
|
more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License along
|
||||||
|
with this source code. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
@ -0,0 +1,71 @@
|
||||||
|
#!/bin/sh
|
||||||
|
# Copyright (c) 2016 parazyd <parazyd@dyne.org>
|
||||||
|
# nanodoc is written and maintained by parazyd
|
||||||
|
#
|
||||||
|
# This file is part of arm-sdk
|
||||||
|
#
|
||||||
|
# This source code is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This software is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with this source code. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
org="parazyd <parazyd@dyne.org> | dyne.org"
|
||||||
|
name=libdevuansdk
|
||||||
|
version=2.0
|
||||||
|
desc="common.lib.for.devuan.sdks"
|
||||||
|
|
||||||
|
pages="
|
||||||
|
libdevuansdk.7"
|
||||||
|
|
||||||
|
|
||||||
|
generate_manpages() {
|
||||||
|
for page in $pages; do
|
||||||
|
ronn -r --manual=$name --organization="$org" ${page}.md
|
||||||
|
done
|
||||||
|
|
||||||
|
mkdir -p man/7
|
||||||
|
mv *.7 man/7
|
||||||
|
}
|
||||||
|
|
||||||
|
generate_html() {
|
||||||
|
mkdir -p html
|
||||||
|
sed -i -e 's/NAME/'$name'/' -e 's/DESC/'$desc'/g' static/head.html
|
||||||
|
sed -i -e 's/VERSION/'$version'/' static/foot.html
|
||||||
|
|
||||||
|
for page in $pages; do
|
||||||
|
pagetitle=$(sed 1q ${page}.md)
|
||||||
|
printf '<li><a href="%s.html" class="notPage">%s</a></li>\n' $page $pagetitle >> nav.html
|
||||||
|
done
|
||||||
|
|
||||||
|
printf "</ul></div><div id='main'>\n" >> nav.html
|
||||||
|
|
||||||
|
for page in $pages; do
|
||||||
|
printf "\thtml/%s\n" ${page}
|
||||||
|
cat static/head.html > html/${page}.html
|
||||||
|
cat nav.html >> html/${page}.html
|
||||||
|
python -m markdown ${page}.md >> html/${page}.html
|
||||||
|
cat static/foot.html >> html/${page}.html
|
||||||
|
|
||||||
|
pagetitle=$(sed 1q ${page}.md)
|
||||||
|
sed -i -e 's/TITLE/'$pagetitle'/' html/${page}.html
|
||||||
|
sed -i -e 's/'$page'.html" class="notPage/'$page'.html" class="thisPage/' html/${page}.html
|
||||||
|
done
|
||||||
|
|
||||||
|
ln -sf libdevuansdk.7.html html/index.html
|
||||||
|
#cat nav.html
|
||||||
|
rm -f nav.html
|
||||||
|
}
|
||||||
|
|
||||||
|
case $1 in
|
||||||
|
man) generate_manpages && exit 0 ;;
|
||||||
|
html) generate_html && exit 0 ;;
|
||||||
|
*) exit 1 ;;
|
||||||
|
esac
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="footer">
|
||||||
|
<span class="right">
|
||||||
|
<a href="https://git.devuan.org/sdk/libdevuansdk">libdevuansdk-VERSION</a>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,199 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>TITLE</title>
|
||||||
|
|
||||||
|
<style type="text/css">
|
||||||
|
/* {{{ stylesheet */
|
||||||
|
body {
|
||||||
|
background-color: #eee;
|
||||||
|
color: #222;
|
||||||
|
font-family: sans-serif;
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
hr { margin: 30px 60px; }
|
||||||
|
|
||||||
|
code {
|
||||||
|
font-family: monospace;
|
||||||
|
background-color: #ccc;
|
||||||
|
padding: 0.2ex 0.5ex 0.2ex 0.5ex;
|
||||||
|
margin: 0.2ex;
|
||||||
|
border-radius: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
a, a:visited {
|
||||||
|
color: #058;
|
||||||
|
text-decoration: none;
|
||||||
|
-webkit-transition: all 0.2s linear;
|
||||||
|
-moz-transition: all 0.2s linear;
|
||||||
|
-ms-transition: all 0.2s linear;
|
||||||
|
-o-transition: all 0.2s linear;
|
||||||
|
transition: all 0.2s linear;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
background-color: #eee;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#menu {
|
||||||
|
clear: both;
|
||||||
|
overflow: hidden;
|
||||||
|
color: #069;
|
||||||
|
background-color: #333;
|
||||||
|
padding: 0.7ex;
|
||||||
|
font-size: 94%;
|
||||||
|
border-top: 1px solid #333;
|
||||||
|
border-bottom: 1px solid #333;
|
||||||
|
}
|
||||||
|
|
||||||
|
#menu a {
|
||||||
|
padding: 0.5ex 1ex 0.5ex 1ex;
|
||||||
|
color: #fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#menu a:hover {
|
||||||
|
background-color: #333;
|
||||||
|
color: #17a;
|
||||||
|
}
|
||||||
|
|
||||||
|
#menu a.thisSite {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
#header {
|
||||||
|
clear: both;
|
||||||
|
color: #666;
|
||||||
|
font-size: 1.78em;
|
||||||
|
padding: 0.7ex 0.7ex 0.7ex 0.7em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#header img {
|
||||||
|
width: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#headerLink {
|
||||||
|
color: #666;
|
||||||
|
margin-left: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-family: sans-serif;
|
||||||
|
margin: 1em 1ex 0.5ex 0;
|
||||||
|
font-size: 1.4em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h2 {
|
||||||
|
font-family: sans-serif;
|
||||||
|
margin: 1em 1ex 0.5ex 0;
|
||||||
|
font-size: 1.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3 {
|
||||||
|
font-family: sans-serif;
|
||||||
|
margin: 1em 1ex 0.5ex 0;
|
||||||
|
font-size: 1.0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h4 {
|
||||||
|
font-family: sans-serif;
|
||||||
|
margin: 1em 1ex 0.5ex 0;
|
||||||
|
font-size: 0.9em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#headerSubtitle {
|
||||||
|
font-size: 0.75em;
|
||||||
|
font-style: italic;
|
||||||
|
margin-left: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
clear: both;
|
||||||
|
font-size: 0.9em;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
background-color: #fff;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav {
|
||||||
|
background-color: #fff;
|
||||||
|
float: left;
|
||||||
|
margin: 0 1px 0 0;
|
||||||
|
padding: 1em 0;
|
||||||
|
border-right: 1px dotted #ccc;
|
||||||
|
width: 200px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav li {
|
||||||
|
list-style: none;
|
||||||
|
font-size: 0.8em;
|
||||||
|
padding: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav li ul {
|
||||||
|
padding-left: 0.6em !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav li a {
|
||||||
|
display: block;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0.8ex 2em 0.8ex 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#nav li a.thisPage {
|
||||||
|
color: #222; /*#333;*/
|
||||||
|
font-weight: bold;
|
||||||
|
/*font-style: italic;*/
|
||||||
|
}
|
||||||
|
|
||||||
|
#main {
|
||||||
|
margin: 0 0 0 200px;
|
||||||
|
padding: 1.5em;
|
||||||
|
max-width: 50em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#footer {
|
||||||
|
clear: both;
|
||||||
|
color: #666;
|
||||||
|
border-top: 1px solid #ccc;
|
||||||
|
font-size: 84%;
|
||||||
|
padding: 1em;
|
||||||
|
margin: 0 0 1.5em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.left {
|
||||||
|
float: left;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.right {
|
||||||
|
float: right;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
/* }}} */
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="header">
|
||||||
|
<a id="headerLink" href="html">libdevuansdk</a>
|
||||||
|
<span id="headerSubtitle">DESC</span>
|
||||||
|
</div>
|
||||||
|
<div id="menu"></div>
|
||||||
|
|
||||||
|
<div id="content">
|
||||||
|
<div id="nav">
|
||||||
|
|
||||||
|
<ul>
|
||||||
Loading…
Reference in New Issue