Skip to content

Commit

Permalink
README files/folders overview
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanR712 committed Dec 18, 2023
1 parent 8edce5c commit 7b6be5e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,22 @@ Made with [mdBook](https://github.com/rust-lang/mdBook).

Install rust, cargo and mdbook.
Then, run "mdbook build" in the **root directory** and ensure the message "Running the html backend" appears.


# Root Files and Folders

```
/.github/ : Builds and deploys the mdBook.
/.vscode/ : Recommended extensions and settings for using VSCode as a text editor.
/src/ : Markdown files that are built into the mdBook.
/.gitignore : Files and directories that should not be updated with git version control.
/book.toml : Config file for mdBook.
/LICENSE : Legal jargon for who can buy and sell the book.
/README.md : Information about the book and its contents. You are here!
```

0 comments on commit 7b6be5e

Please sign in to comment.