From ff215b455ca97f453cf9b5c171bdbe49c24048a2 Mon Sep 17 00:00:00 2001 From: Aaron Spring <aaron.spring@mpimet.mpg.de> Date: Thu, 29 Apr 2021 08:41:46 +0000 Subject: [PATCH] Update README.md --- README.md | 38 ++++---------------------------------- 1 file changed, 4 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index d80efdb..1053489 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,8 @@ # s2s-ai-challenge -## Introduction +This is the gitlab project organizing the `s2s-ai-challenge`. It hosts: -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`. +- [issue tracker](https://renkulab.io/gitlab/aaron.spring/s2s-ai-challenge/-/issues) for discussions under the `discussion` label. +- [issue tracker](https://renkulab.io/gitlab/aaron.spring/s2s-ai-challenge/-/issues) for issues regarding the code and organization to be reported by users and organizers. +- [wiki](https://renkulab.io/gitlab/aaron.spring/s2s-ai-challenge/-/wikis/home) for more information, e.g. FAQ transferred from issue tracker, resources, etc. -## 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! \ No newline at end of file -- GitLab