-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README with install instructions.
- Loading branch information
1 parent
478389e
commit 738c519
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# [tensorflow.rstudio.com](https://tensorflow.rstudio.com) sources | ||
|
||
Here you can find the source code for the website https://tensorflow.rstudio.com (also https://keras.rstudio.com, which redirects to https://tensorflow.rstudio.com). | ||
|
||
Contributions are welcome! | ||
If you would like to propose changes to the website: | ||
|
||
1. Fork and clone this repository | ||
2. Run or `source()` the R script \_utils/create-r-tensorflow-website-venv.R. | ||
|
||
``` bash | ||
Rscript _utils/create-r-tensorflow-website-venv.R | ||
``` | ||
|
||
3. Install [quarto](https://quarto.org/docs/get-started/). | ||
4. At the terminal, run `quarto preview` . The first time you run this it will take up to 10 minutes to create a new folder in the project: "\_site". This is a local build of the website you will be able to work with interactively. Once quarto is done rendering the local site, you it will open a browser where you can preview your changes live. | ||
5. Modify the files you are interested in changing using your editor of choice (e.g., RStudio). `quarto preview` will automatically execute and rerender the updated qmds and you will see your changes reflected in the live preview in the browser. | ||
6. Once you're happy with your changes, push them to your forked repo and open a pull request. | ||
|
||
If you run into any difficulties with the instructions above, please don't hesitate to file an [issue](https://github.com/rstudio/tensorflow.rstudio.com/issues/new). |