Skip to content

Commit

Permalink
updated the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Rishabh672003 committed Dec 24, 2023
1 parent a0bd968 commit 33b7016
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,22 @@ What we are now working on basic Computer Science concepts like different Data S
If you want to contribute to the repository don't be afraid to open a PR
if its good, We will most definitely merge it. Thanks for your time.

## Development

This has been made with [mdbook](https://github.com/rust-lang/mdBook),
so to get started do the following step -

1. All markdown files need to be added to `src` folder then Append/Edit the `src/SUMMARY.md` to add pages and change the structure of the book website.

2. Start the mdbook server to see the changes with `mdbook serve --open`

3. Then to publish the book just do `mdbook build`

4. Push the changes and the Github action will automatically publish the website

Now at least all the CPP notes are hosted on this website - https://rishabh672003.github.io/Programming-Notes/
So you can add more notes and make pull request to this branch

## Credits

For CPP notes: Credit to [developer-roadmap](https://github.com/kamranahmedse/developer-roadmap) and [roadmap.sh](roadmap.sh), I followed there roadmap and
Expand Down

0 comments on commit 33b7016

Please sign in to comment.