Skip to content

Commit 745bc03

Browse files
docs: update readme
1 parent ce7bd34 commit 745bc03

1 file changed

Lines changed: 31 additions & 25 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 31 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,56 @@
11
# Nelson GitBook πŸ“š
22

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.
114

125
## Introduction 🌟
136

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.
158

169
## Prerequisites πŸ› οΈ
1710

18-
- [rust](https://www.rust-lang.org/tools/install) (mdbook)
11+
Before you begin, ensure you have the following installed:
1912

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)
2315

24-
- node (prettier)
16+
To set up your environment:
2517

2618
```bash
2719
nvm use .
2820
npm install
2921
```
3022

31-
- Nelson (version that you want to add help files)
32-
3323
## Installation βš™οΈ
3424

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:
3626

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.
4135

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.
4346

4447
## License πŸ“œ
4548

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.
4750

48-
Happy coding with Nelson! πŸŽ‰
51+
## Contact πŸ“§
52+
53+
Maintainer: Allan CORNET
54+
Email: <nelson.numerical.computation@gmail.com>
4955

50-
Contact: Allan CORNET (<nelson.numerical.computation@gmail.com>)
56+
Happy coding with Nelson! πŸŽ‰

0 commit comments

Comments
Β (0)