Libyan Enterprises Programming Guide is a unified guide for programming standards that crafted specially for Libyan enterprises.
TODO
Libyan Enterprises Programming Guide is written in mdBook, though the following softwares are required:
- Install Rust programming language and Cargo
- Install mdBook by running
cargo install mdbook
Note: The previous steps tested on Ubuntu 20.04 OS. A specific steps need to be added for other OSs.
- Fork this repo
- Clone the fork to your machine
- Open an issue with the chapter/section you want to add/update
- Agree on a general writing proposal
- Create a new branch and commit your changes
- Open a pull request linking to the issue
All mdBook configuration are available wihtin book.toml file.
The content of this guide is lies in src folder.
Each chapter has its own file named with its name and ends with .md extension (e.g المقدمة.md).
To edit any of the contents, you can edit the files in src folder directly.
mdBook uses Markdown, specifically CommonMark specification.
So, make sure to follow the mentioned specifications.
Note: The content of this guide it written in Arabic language. Why? Currently, I have two reasons:
- Remind the writer about why we are creating this guide.
- Make it easy for our audiences to understand and benefit from it.
The theme style is exists under theme folder.
It is the default mdBook theme except for the RTL support (review this commit).
The RTL support needs to be revisited by an expert in future (maybe you ?.?)
and it could be contributed to mdBook repository directly in future after creating a mature enought RTL theme.
Once you finish the changes on the configuration, content or the theme,
you can run mdbook build -o and the guide will open on your browser so you can review it before publishing new PRs.
For more information, review mdBook documentation from here.