iscsc / docs

Useful resources & tutorials

@Iscsc/docs - Documentation, tutorials & useful resources

Submit a PR - Report an error - Explore the docs »

Contributing

If you wish to contribute, follows these steps:

• Write a Markdown file following the CommonMark standard.
• Add to SUMMARY.md file the following line - [Short title](filename.md).

If you want to add references to programs and scripts, you can put them in scripts folder.

Usage

This book is built using the mdbook utility (see mdbook official documentation for more information). Before building this book, you need to install rust. Once rust is installed on your machine, run cargo install mdbook. To read this book in a browser, simply use mdbook serve --open.

License

This part is related to OS-development, more specifically work based on the Linux From Scratch Project.

---

⚠️ This work is not endorsed by the Linux from Scratch project or any of the third-parties mentioned in the Acknowledgments & Bibliography section.

The document itself is distributed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 License (see src/LICENSE for more information). The computer instructions may be extracted from the document following the MIT License (see scripts/LICENSE for more information).

Copyright © 1999-2022, Gerard Beekmans. All rights reserved.

Note: this document is based on the resources provided by the Linux from Scratch Project (see Credits). The LFS & BLFS books are licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 2.0 License. Creative Commons states that new works should be moved the newer version (4.0). That's why this work is licensed under the 4.0 version.

---

Acknowledgments & Bibliography

• The Linux from Scratch Project (https://www.linuxfromscratch.org/)
• Mendel Cooper, Building and Installing Software Packages for Linux (1999), The Linux Documentation Project (https://tldp.org/HOWTO/Software-Building-HOWTO.html#toc17)

docs's Issues

missing `mdbook` dependencies

i followed the instructions to build the server and get

>_ mdbook serve --open
2023-04-10 12:53:17 [INFO] (mdbook::book): Book building has started
2023-04-10 12:53:17 [WARN] (mdbook::preprocess::cmd): The command wasn't found, is the "admonish" preprocessor installed?
2023-04-10 12:53:17 [WARN] (mdbook::preprocess::cmd): 	Command: mdbook-admonish
2023-04-10 12:53:17 [ERROR] (mdbook::utils): Error: Unable to start the "katex" preprocessor. Is it installed?
2023-04-10 12:53:17 [ERROR] (mdbook::utils): 	Caused By: No such file or directory (os error 2)

which can be solved with

cargo install mdbook-admonish mdbook-katex

😉