aboutsummaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
authorThijs Schreijer <thijs@thijsschreijer.nl>2023-11-15 07:48:12 +0100
committerThijs Schreijer <thijs@thijsschreijer.nl>2023-11-15 19:17:57 +0100
commit048f3cec7a18e7a28146f03c3c9e5d89d9613028 (patch)
tree41e8630938542fe1ec79ba4eff4304d85b45835e /docs/topics
parent5f3951a942fdc4bf489d8d590bfc891ac9548a23 (diff)
downloadluasystem-048f3cec7a18e7a28146f03c3c9e5d89d9613028.tar.gz
luasystem-048f3cec7a18e7a28146f03c3c9e5d89d9613028.tar.bz2
luasystem-048f3cec7a18e7a28146f03c3c9e5d89d9613028.zip
chore(docs): render the documentation
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/01-introduction.md.html70
-rw-r--r--docs/topics/CHANGELOG.md.html121
-rw-r--r--docs/topics/LICENSE.md.html79
3 files changed, 270 insertions, 0 deletions
diff --git a/docs/topics/01-introduction.md.html b/docs/topics/01-introduction.md.html
new file mode 100644
index 0000000..2901cc9
--- /dev/null
+++ b/docs/topics/01-introduction.md.html
@@ -0,0 +1,70 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
5<head>
6 <title>Lua-System docs</title>
7 <link rel="stylesheet" href="../ldoc.css" type="text/css" />
8</head>
9<body>
10
11<div id="container">
12
13<div id="product">
14 <div id="product_logo"></div>
15 <div id="product_name"><big><b></b></big></div>
16 <div id="product_description"></div>
17</div> <!-- id="product" -->
18
19
20<div id="main">
21
22
23<!-- Menu -->
24
25<div id="navigation">
26<br/>
27<h1>Lua-System</h1>
28
29
30
31
32<h2>Topics</h2>
33<ul class="">
34 <li><strong>1. Introduction</strong></li>
35 <li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li>
36 <li><a href="../topics/LICENSE.md.html">MIT License</a></li>
37</ul>
38<h2>Modules</h2>
39<ul class="nowrap">
40 <li><a href="../index.html">system</a></li>
41</ul>
42
43</div>
44
45<div id="content">
46
47
48<h1>1. Introduction</h1>
49
50<p>luasystem is a platform independent system call library for Lua.
51Supports Unix, Windows, MacOS, <code>Lua &gt;= 5.1</code> and <code>luajit &gt;= 2.0.0</code>.</p>
52
53<p>Lua is typically platform independent, but it requires adhering to very old C
54standards. This in turn means that many common features (according to todays standards)
55are not available. This module attempts to overcome some of those hurdles by providing
56functions that cover those common needs.</p>
57
58<p>This is not a kitchen sink library, but a minimalistic one with a focus on platform
59independence.</p>
60
61
62</div> <!-- id="content" -->
63</div> <!-- id="main" -->
64<div id="about">
65<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
66<i style="float:right;">Last updated 2023-11-15 07:42:18 </i>
67</div> <!-- id="about" -->
68</div> <!-- id="container" -->
69</body>
70</html>
diff --git a/docs/topics/CHANGELOG.md.html b/docs/topics/CHANGELOG.md.html
new file mode 100644
index 0000000..f909b4b
--- /dev/null
+++ b/docs/topics/CHANGELOG.md.html
@@ -0,0 +1,121 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
5<head>
6 <title>Lua-System docs</title>
7 <link rel="stylesheet" href="../ldoc.css" type="text/css" />
8</head>
9<body>
10
11<div id="container">
12
13<div id="product">
14 <div id="product_logo"></div>
15 <div id="product_name"><big><b></b></big></div>
16 <div id="product_description"></div>
17</div> <!-- id="product" -->
18
19
20<div id="main">
21
22
23<!-- Menu -->
24
25<div id="navigation">
26<br/>
27<h1>Lua-System</h1>
28
29
30<h2>Contents</h2>
31<ul>
32<li><a href="#Versioning">Versioning </a></li>
33<li><a href="#Version_history">Version history </a></li>
34</ul>
35
36
37<h2>Topics</h2>
38<ul class="">
39 <li><a href="../topics/01-introduction.md.html">1. Introduction</a></li>
40 <li><strong>CHANGELOG</strong></li>
41 <li><a href="../topics/LICENSE.md.html">MIT License</a></li>
42</ul>
43<h2>Modules</h2>
44<ul class="nowrap">
45 <li><a href="../index.html">system</a></li>
46</ul>
47
48</div>
49
50<div id="content">
51
52
53<h1>CHANGELOG</h1>
54
55<p><a name="Versioning"></a></p>
56<h2>Versioning</h2>
57
58<p>This library is versioned based on Semantic Versioning (<a href="https://semver.org/">SemVer</a>).</p>
59
60<h4>Version scoping</h4>
61
62<p>The scope of what is covered by the version number excludes:</p>
63
64<ul>
65 <li>error messages; the text of the messages can change, unless specifically documented.</li>
66</ul>
67
68<h4>Releasing new versions</h4>
69
70<ul>
71 <li>create a release branch</li>
72 <li>update the changelog below</li>
73 <li>update version and copyright-years in <code>./LICENSE.md</code> and <code>./src/time.c</code> (in module constants)</li>
74 <li>create a new rockspec and update the version inside the new rockspec:<br/>
75 <code>cp luasystem-scm-0.rockspec ./rockspecs/luasystem-X.Y.Z-1.rockspec</code></li>
76 <li>clean and render the docs: run <code>ldoc .</code></li>
77 <li>commit the changes as <code>Release vX.Y.Z</code></li>
78 <li>push the commit, and create a release PR</li>
79 <li>after merging tag the release commit with <code>vX.Y.Z</code></li>
80 <li>upload to LuaRocks:<br/>
81 <code>luarocks upload ./rockspecs/luasystem-X.Y.Z-1.rockspec --api-key=ABCDEFGH</code></li>
82 <li>test the newly created rock:<br/>
83 <code>luarocks install luasystem</code></li>
84</ul>
85
86<p><a name="Version_history"></a></p>
87<h2>Version history</h2>
88
89<h3>Version X.Y.Z, unreleased</h3>
90
91<ul>
92 <li>Feat: on Windows <a href="../index.html#sleep">sleep</a> now has a precision parameter</li>
93 <li>Feat: <a href="../index.html#setenv">setenv</a> added to set environment variables.</li>
94 <li>Feat: <a href="../index.html#getenvs">getenvs</a> added to list environment variables.</li>
95 <li>Feat: <a href="../index.html#getenv">getenv</a> added to get environment variable previously set (Windows).</li>
96 <li>Feat: <a href="../index.html#random">random</a> added to return high-quality random bytes</li>
97 <li>Feat: <a href="../index.html#isatty">isatty</a> added to check if a file-handle is a tty</li>
98</ul>
99
100<h3>Version 0.2.1, released 02-Oct-2016</h3>
101
102<h3>Version 0.2.0, released 08-May-2016</h3>
103
104<h3>Version 0.1.1, released 10-Apr-2016</h3>
105
106<h3>Version 0.1.0, released 11-Feb-2016</h3>
107
108<ul>
109 <li>initial release</li>
110</ul>
111
112
113</div> <!-- id="content" -->
114</div> <!-- id="main" -->
115<div id="about">
116<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
117<i style="float:right;">Last updated 2023-11-15 07:42:18 </i>
118</div> <!-- id="about" -->
119</div> <!-- id="container" -->
120</body>
121</html>
diff --git a/docs/topics/LICENSE.md.html b/docs/topics/LICENSE.md.html
new file mode 100644
index 0000000..67614d2
--- /dev/null
+++ b/docs/topics/LICENSE.md.html
@@ -0,0 +1,79 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
5<head>
6 <title>Lua-System docs</title>
7 <link rel="stylesheet" href="../ldoc.css" type="text/css" />
8</head>
9<body>
10
11<div id="container">
12
13<div id="product">
14 <div id="product_logo"></div>
15 <div id="product_name"><big><b></b></big></div>
16 <div id="product_description"></div>
17</div> <!-- id="product" -->
18
19
20<div id="main">
21
22
23<!-- Menu -->
24
25<div id="navigation">
26<br/>
27<h1>Lua-System</h1>
28
29
30
31
32<h2>Topics</h2>
33<ul class="">
34 <li><a href="../topics/01-introduction.md.html">1. Introduction</a></li>
35 <li><a href="../topics/CHANGELOG.md.html">CHANGELOG</a></li>
36 <li><strong>MIT License</strong></li>
37</ul>
38<h2>Modules</h2>
39<ul class="nowrap">
40 <li><a href="../index.html">system</a></li>
41</ul>
42
43</div>
44
45<div id="content">
46
47
48<h1>MIT License</h1>
49
50<h3>Copyright (c) 2016-2023 Oscar Lim</h3>
51
52<p>Permission is hereby granted, free of charge, to any person obtaining a copy of
53this software and associated documentation files (the "Software"), to deal in
54the Software without restriction, including without limitation the rights to
55use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
56of the Software, and to permit persons to whom the Software is furnished to do
57so, subject to the following conditions:</p>
58
59<p>The above copyright notice and this permission notice shall be included in all
60copies or substantial portions of the Software.</p>
61
62<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
63IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
64FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
65AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
66LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
67OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
68SOFTWARE.</p>
69
70
71</div> <!-- id="content" -->
72</div> <!-- id="main" -->
73<div id="about">
74<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
75<i style="float:right;">Last updated 2023-11-15 07:42:18 </i>
76</div> <!-- id="about" -->
77</div> <!-- id="container" -->
78</body>
79</html>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-10-04 05:26:35 +0000