WIP started readme

README.md

@@ -1,11 +1,22 @@
-# My python package template
+# JZ-hydra-submitit-launcher
 
-![GitHub Workflow Build Status](https://github.com/zaccharieramzi/my-python-package-template/workflows/Continuous%20testing/badge.svg)
+![GitHub Workflow Build Status](https://github.com/zaccharieramzi/jz-hydra-submitit-launcher/workflows/Continuous%20testing/badge.svg)
 
-With Readme, gitignore, travis, GitHub workflow, reqs and tree structure
+A Jean Zay tailored Hydra submitit launcher based on [Hydra](https://hydra.cc/docs/intro/) and its [submitit-launcher plugin](https://hydra.cc/docs/plugins/submitit_launcher/).
+Basically it extends the submitit-launcher plugin with defaults that make sense for Jean Zay.
 
-TODO to make the repo viable:
-- [ ] change the name of the `my_package` folder
-- [ ] change the name of the package in `setup.py`
-- [ ] change the name of the test folder in the GitHub action
-- [ ] Updated the Readme
+## Install
+
+This package can be installed via pip:
+```
+pip install jz-hydra-submitit-launcher
+```
+
+You can also install it from source:
+```
+git clone https://github.com/zaccharieramzi/jz-hydra-submitit-launcher.git
+cd jz-hydra-submitit-launcher
+pip install .
+```
+
+## Use