Skip to content

Commit

Permalink
added documentation command to README.md
Browse files Browse the repository at this point in the history
- We were running into the issue where if you just run cargo doc --open it would generate just a black html page despite all of our /// comments
- We're not sure what is going wrong here but we found a source talking about the visabilty needing to be public but everything we have is public?
- we found a work around here rust-lang/cargo#1865 from Bart Massey himself
  • Loading branch information
LiamRotchford5671 authored Aug 7, 2019
1 parent 062650a commit 43c2c3e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ To build or run an optimized version, use `cargo --release`.

Run `cargo test` to do some simple testing. Though it should be noted that the main form of testing for this project is human visual, i.e does the image generate in the way we expect visually.

## Documentation
To read each files inner documentation about functionality and purpose run the follow:

cargo rustdoc --open -- --document-private-items

## Fractal Generation Examples
![Barnsley](https://i.imgur.com/KPU4MaJ.png)
![Julia](https://i.imgur.com/TzwaN9f.png)
Expand Down

0 comments on commit 43c2c3e

Please sign in to comment.