Update doc

This commit is contained in:
Cecile Tonglet 2020-09-21 13:40:32 +02:00
parent 8d8d19bd69
commit 9578c54047

View file

@ -13,6 +13,12 @@ a star to let me know you are interested in this project.
Installation Installation
------------ ------------
## Use as a library (in your project)
```toml
yewprint = { git = "https://github.com/cecton/yewprint.git", branch = "main" }
```
## Development ## Development
This section will walk you through setting up the environment required to modify This section will walk you through setting up the environment required to modify
@ -25,7 +31,7 @@ the source of `yewprint`.
- [simple-http-server](https://github.com/TheWaWaR/simple-http-server) - [simple-http-server](https://github.com/TheWaWaR/simple-http-server)
- [cargo-watch](https://github.com/passcod/cargo-watch) - [cargo-watch](https://github.com/passcod/cargo-watch)
#### Troubleshooting ### Troubleshooting
- I can't install `cargo-watch` on OSX. - I can't install `cargo-watch` on OSX.
@ -33,13 +39,7 @@ the source of `yewprint`.
[pre-compiled binary](https://github.com/passcod/cargo-watch/releases) [pre-compiled binary](https://github.com/passcod/cargo-watch/releases)
instead. instead.
### Use as a library ### Run the development server
```toml
yewprint = { git = "https://github.com/cecton/yewprint.git", branch = "main" }
```
### Development server
``` ```
./dev.sh ./dev.sh