From e757d50286d694bd740a6249fe50d8fbc490b88b Mon Sep 17 00:00:00 2001 From: moein Date: Thu, 23 May 2024 01:33:33 +0330 Subject: [PATCH] =?UTF-8?q?Update=20CONTRIBUTING.md=20=F0=9F=94=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + CONTRIBUTING.md | 12 +++++------- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index 60466ba..4d39706 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ bin/ +book/ todo.md gh-md-toc diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3645989..91e956e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,22 @@ # Contributing First of all, thank you for reading here to contribute! I really appriciate that.
-Please do not modify files in the `book` directory as they are generated by `mdbook`. Make changes in the `src` directory instead. ## Share experience -If you want to share your interview experience, If the company exist in the `src`, just create a `md` file with company name in the `src`. If the company is not exist, create a directory with company name and put each experience on it. -Then for compile, you need to add your `md` file to `SUMMARY.md`. +If you want to share your interview experience, create a directory with company name (if not exist) and put your `md` file in it. +Then for compile, you need to add your `md` file path to `SUMMARY.md`. Just like this: ``` src/snapp ├── snapp_cab_1.md -├── snapp_cab_2.md -├── snapp_market_pro.md -└── snapp.md +└── snapp_cab_2.md ``` You can add your name (if you like) after the company name like: `snapp_moein.md` and that's good to write it in the file otherwise, write `unknown`. ## Install You need to install mdbook. Just install binaries if you are not familiar with `rust` and `cargo`.
-Watch this [link](https://github.com/rust-lang/mdBook/releases) for releases. +Watch this [link](https://github.com/rust-lang/mdBook/releases) for releases.
+For mermaid charts, install [this](https://github.com/badboy/mdbook-mermaid). ## Build For building after your changes in the root dir of project: