Skip to content

Commit 37d1bd7

Browse files
Nelson-numerical-softwareNelson-numerical-software
committed
docs: update documentation and add new resources
- Add LICENSE - Add README.md - Update book.toml
1 parent 84b7ddf commit 37d1bd7

File tree

2,774 files changed

+2274175
-114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,774 files changed

+2274175
-114
lines changed

‎.github/workflows/generate_pdf.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
- run: docker run --rm -v "$PWD:/gitbook" -p 4000:4000 billryan/gitbook gitbook init
1818
- run: |
1919
cd /home/runner/work/nelson-gitbook/nelson-gitbook
20-
docker run --rm -v "$PWD:/gitbook" -p 4000:4000 billryan/gitbook gitbook pdf .
20+
docker run --rm -v "$PWD:/gitbook" -p 4000:4000 billryan/gitbook gitbook pdf ./markdown
2121
- run: mkdir /home/runner/work/nelson-gitbook/nelson-gitbook/artifacts
2222
- run: cp /home/runner/work/nelson-gitbook/nelson-gitbook/*.pdf /home/runner/work/nelson-gitbook/nelson-gitbook/artifacts
2323
- uses: actions/upload-artifact@v4

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
*.bak
22
node_modules/
33
package-lock.json
4-
book
4+
book
5+
docs/index.md

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
22.12.0

‎LICENSE

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Nelson GitBook 📚
2+
3+
Welcome to the Nelson GitBook repository! This project contains the documentation for the Nelson programming language.
4+
5+
## Table of Contents 📑
6+
7+
- [Introduction](#introduction)
8+
- [Prerequisites](#Prerequisites)
9+
- [Installation](#installation)
10+
- [License](#license)
11+
12+
## Introduction 🌟
13+
14+
Nelson is a powerful and easy-to-use programming language designed for simplicity and efficiency. This GitBook provides comprehensive documentation to help you get started and make the most of Nelson.
15+
16+
## Prerequisites 🛠️
17+
18+
- [rust](https://www.rust-lang.org/tools/install) (mdbook)
19+
20+
```bash
21+
cargo install mdbook
22+
```
23+
24+
- node (prettier)
25+
26+
```bash
27+
nvm use .
28+
npm install
29+
```
30+
31+
- Nelson (version that you want to add help files)
32+
33+
## Installation ⚙️
34+
35+
`update_help` will extract all help files, convert them to markdown, prettify, and convert them to HTML.
36+
37+
```matlab
38+
% from nelson-gitbook root directory
39+
run('./scripts/update_help.m);
40+
```
41+
42+
Commit modified files and check results: <https://nelson-lang.github.io/nelson-gitbook/>
43+
44+
## License 📜
45+
46+
This project is licensed under same license than Nelson. See the [LICENSE](LICENSE) file for more details.
47+
48+
Happy coding with Nelson! 🎉
49+
50+
Contact: Allan CORNET (<[email protected]>)

‎book.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
authors = ["Allan CORNET"]
33
language = "en"
44
multilingual = false
5-
src = "./en/"
5+
src = "./markdown/en/"
66
title = "Nelson"
77

88
[output.html]

‎docs/index.html

+26-104
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,29 @@
1-
<!DOCTYPE html>
2-
<html lang="en">
3-
<head>
4-
<meta charset="UTF-8">
5-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6-
<title>Main Page</title>
7-
<style>
8-
body {
9-
font-family: Arial, sans-serif;
10-
line-height: 1.6;
11-
}
12-
nav {
13-
margin-bottom: 20px;
14-
}
15-
nav a {
16-
margin-right: 10px;
17-
text-decoration: none;
18-
color: blue;
19-
}
20-
nav a:hover {
21-
text-decoration: underline;
22-
}
23-
</style>
24-
</head>
25-
<body>
26-
<header>
27-
<h1>Welcome to the Main Page</h1>
28-
<nav>
29-
<a href="page1.html">Page 1</a>
30-
<a href="page2.html">Page 2</a>
31-
<a href="page3.html">Page 3</a>
32-
</nav>
33-
</header>
34-
<main>
35-
<p>This is the main page of the website. Use the links above to navigate to the internal pages.</p>
36-
</main>
37-
</body>
38-
</html>
1+
<h1>📚 Nelson Documentation</h1>
392

40-
<!-- page1.html -->
41-
<!DOCTYPE html>
42-
<html lang="en">
43-
<head>
44-
<meta charset="UTF-8">
45-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
46-
<title>Page 1</title>
47-
</head>
48-
<body>
49-
<header>
50-
<h1>Page 1</h1>
51-
<nav>
52-
<a href="index.html">Home</a>
53-
<a href="page2.html">Page 2</a>
54-
<a href="page3.html">Page 3</a>
55-
</nav>
56-
</header>
57-
<main>
58-
<p>Welcome to Page 1. Use the links above to navigate.</p>
59-
</main>
60-
</body>
61-
</html>
3+
<p>Welcome to the Nelson online documentation! Here you will find all the information you need to use and contribute to Nelson.</p>
624

63-
<!-- page2.html -->
64-
<!DOCTYPE html>
65-
<html lang="en">
66-
<head>
67-
<meta charset="UTF-8">
68-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
69-
<title>Page 2</title>
70-
</head>
71-
<body>
72-
<header>
73-
<h1>Page 2</h1>
74-
<nav>
75-
<a href="index.html">Home</a>
76-
<a href="page1.html">Page 1</a>
77-
<a href="page3.html">Page 3</a>
78-
</nav>
79-
</header>
80-
<main>
81-
<p>Welcome to Page 2. Use the links above to navigate.</p>
82-
</main>
83-
</body>
84-
</html>
5+
<h2>🌐 Useful Links</h2>
856

86-
<!-- page3.html -->
87-
<!DOCTYPE html>
88-
<html lang="en">
89-
<head>
90-
<meta charset="UTF-8">
91-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
92-
<title>Page 3</title>
93-
</head>
94-
<body>
95-
<header>
96-
<h1>Page 3</h1>
97-
<nav>
98-
<a href="index.html">Home</a>
99-
<a href="page1.html">Page 1</a>
100-
<a href="page2.html">Page 2</a>
101-
</nav>
102-
</header>
103-
<main>
104-
<p>Welcome to Page 3. Use the links above to navigate.</p>
105-
</main>
106-
</body>
107-
</html>
7+
<ul>
8+
<li><a href="https://nelson-lang.github.io/nelson-website/">🌍 Nelson Website</a></li>
9+
<li><a href="https://github.com/nelson-lang/nelson/">💻 Contribute on GitHub</a></li>
10+
</ul>
11+
12+
<h2>📅 Latest Online Help Version</h2>
13+
14+
<ul>
15+
<li>Current version: <a href="https://nelson-lang.github.io/nelson-gitbook/releases/en_US/v1.11.0/index.html">v1.11.0</a></li>
16+
</ul>
17+
18+
<h2>⏳ Previous Versions</h2>
19+
20+
<ul>
21+
<li><a href="https://nelson-lang.github.io/nelson-gitbook/releases/en_US/v1.11.0/index.html">v1.11.0</a></li>
22+
<li><a href="https://nelson-lang.github.io/nelson-gitbook/releases/en_US/v1.10.0/index.html">v1.10.0</a></li>
23+
</ul>
24+
25+
<h2>🛠️ How to Contribute</h2>
26+
27+
<p>We appreciate all contributions! To get started, check out our <a href="https://github.com/nelson-lang/nelson/blob/master/CONTRIBUTING.md">contribution guide</a>.</p>
28+
29+
<p>Thank you for your support and happy reading! 🚀</p>

0 commit comments

Comments
 (0)