diff --git a/R-minimal/README.md b/R-minimal/README.md index 704363d..fed2a86 100644 --- a/R-minimal/README.md +++ b/R-minimal/README.md @@ -1,2 +1,34 @@ # {{ name }} -A Renku project. + +This is a Renku project - basically a git repository with some +bells and whistles. You'll find we have already created some +useful things like `data` and `notebooks` directories and +a `Dockerfile`. + +## Working with the project + +The simplest way to start your project is right from the Renku +platform - just click on the `Environments` tab and start a new session. +This will start an interactive environment right in your browser. + +To work with the project anywhere outside the Renku platform, +click the `Settings` tab where you will find the +git repo URLs - use `git` to clone the project on whichever machine you want. + +### Changing interactive environment dependencies + +Initially we install a very minimal set of packages to keep the images small. +However, you can add python and conda packages in `requirements.txt` and +`environment.yml` to your heart's content. If you need more fine-grained +control over your environment, please see [the documentation](https://renku.readthedocs.io/en/latest/user/advanced_interfaces.html#dockerfile-modifications). + +## Project configuration + +Project options can be found in `.renku/renku.ini`. In this +project there is currently only one option, which specifies +the default type of environment to open, in this case `/rstudio`. + +## Moving forward + +Once you feel at home with your project, we recommend that you replace +this README file with your own project documentation! Happy data wrangling! diff --git a/python-minimal/README.md b/python-minimal/README.md index 704363d..bdb625a 100644 --- a/python-minimal/README.md +++ b/python-minimal/README.md @@ -1,2 +1,36 @@ # {{ name }} -A Renku project. + +This is a Renku project - basically a git repository with some +bells and whistles. You'll find we have already created some +useful things like `data` and `notebooks` directories and +a `Dockerfile`. + +## Working with the project + +The simplest way to start your project is right from the Renku +platform - just click on the `Environments` tab and start a new session. +This will start an interactive environment right in your browser. + +To work with the project anywhere outside the Renku platform, +click the `Settings` tab where you will find the +git repo URLs - use `git` to clone the project on whichever machine you want. + +### Changing interactive environment dependencies + +Initially we install a very minimal set of packages to keep the images small. +However, you can add python and conda packages in `requirements.txt` and +`environment.yml` to your heart's content. If you need more fine-grained +control over your environment, please see [the documentation](https://renku.readthedocs.io/en/latest/user/advanced_interfaces.html#dockerfile-modifications). + +## Project configuration + +Project options can be found in `.renku/renku.ini`. In this +project there is currently only one option, which specifies +the default type of environment to open, in this case `/lab` for +JupyterLab. You may also choose `/tree` to get to the "classic" Jupyter +interface. + +## Moving forward + +Once you feel at home with your project, we recommend that you replace +this README file with your own project documentation! Happy data wrangling!