|
1 | 1 | # Nelson GitBook π |
2 | 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) |
| 3 | +Welcome to the Nelson GitBook repository! This project hosts the official documentation for the Nelson programming language. |
11 | 4 |
|
12 | 5 | ## Introduction π |
13 | 6 |
|
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. |
| 7 | +Nelson is a powerful, user-friendly programming language focused on simplicity and efficiency. This GitBook provides comprehensive documentation, tutorials, and references to help you get started and master Nelson. |
15 | 8 |
|
16 | 9 | ## Prerequisites π οΈ |
17 | 10 |
|
18 | | -- [rust](https://www.rust-lang.org/tools/install) (mdbook) |
| 11 | +Before you begin, ensure you have the following installed: |
19 | 12 |
|
20 | | -```bash |
21 | | -cargo install mdbook --version 0.4.47 |
22 | | -``` |
| 13 | +- [Node.js](https://nodejs.org/) (for Prettier) |
| 14 | +- [Nelson](https://nelson-lang.github.io/) (any version you wish to document) |
23 | 15 |
|
24 | | -- node (prettier) |
| 16 | +To set up your environment: |
25 | 17 |
|
26 | 18 | ```bash |
27 | 19 | nvm use . |
28 | 20 | npm install |
29 | 21 | ``` |
30 | 22 |
|
31 | | -- Nelson (version that you want to add help files) |
32 | | - |
33 | 23 | ## Installation βοΈ |
34 | 24 |
|
35 | | -`update_help` will extract all help files, convert them to markdown, prettify, and convert them to HTML. |
| 25 | +To generate and update the documentation: |
36 | 26 |
|
37 | | -```matlab |
38 | | -% from nelson-gitbook root directory |
39 | | -run('./scripts/update_help.m); |
40 | | -``` |
| 27 | +1. Run the update script from the root directory to extract all help files, convert them to Markdown, prettify, and generate HTML: |
| 28 | + |
| 29 | + ```matlab |
| 30 | + % From nelson-gitbook root directory |
| 31 | + run('./scripts/update_help.m'); |
| 32 | + ``` |
| 33 | + |
| 34 | +2. Review and commit the modified files. |
41 | 35 |
|
42 | | -Commit modified files and check results: <https://nelson-lang.github.io/nelson-gitbook/> |
| 36 | +3. Check the published documentation at: [https://nelson-lang.github.io/nelson-gitbook/](https://nelson-lang.github.io/nelson-gitbook/) |
| 37 | + |
| 38 | +## Usage π |
| 39 | + |
| 40 | +- Browse the documentation online or locally. |
| 41 | +- To contribute or update help files, edit the relevant source files and rerun the update script. |
| 42 | + |
| 43 | +## Contributing π€ |
| 44 | + |
| 45 | +Contributions are welcome! Please open issues or submit pull requests for improvements, corrections, or new content. |
43 | 46 |
|
44 | 47 | ## License π |
45 | 48 |
|
46 | | -This project is licensed under same license than Nelson. See the [LICENSE](LICENSE) file for more details. |
| 49 | +This project is licensed under the same license as Nelson. See the [LICENSE](LICENSE) file for details. |
47 | 50 |
|
48 | | -Happy coding with Nelson! π |
| 51 | +## Contact π§ |
| 52 | + |
| 53 | +Maintainer: Allan CORNET |
| 54 | +Email: <nelson.numerical.computation@gmail.com> |
49 | 55 |
|
50 | | -Contact: Allan CORNET (<nelson.numerical.computation@gmail.com>) |
| 56 | +Happy coding with Nelson! π |
0 commit comments