From d6413f76289aa59eb6cdce94a8939e700c167592 Mon Sep 17 00:00:00 2001
From: Caroline Malin-Mayor <malinmayorc@janelia.hhmi.org>
Date: Wed, 14 Feb 2024 11:07:06 -0500
Subject: [PATCH] Outlines of README and contributor guide

---
 CONTRIBUTOR.md | 22 ++++++++++++++++++++++
 README.md      | 22 ++++++++++++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 CONTRIBUTOR.md

diff --git a/CONTRIBUTOR.md b/CONTRIBUTOR.md
new file mode 100644
index 000000000..a6c0c11c1
--- /dev/null
+++ b/CONTRIBUTOR.md
@@ -0,0 +1,22 @@
+# Contributor Guide
+
+## Development Installation
+- currently, pip install -r requirements-dev.txt
+and then pip install -e .
+TODO: set up pip install -e .[dev]
+
+## Style and Pre-Commit
+- TODO: pre-commit with black mypy
+- do use ruff and black
+- do have typing, developers should supply types
+
+## Testing
+- Unittest your functions
+- Pytest run automatically on PR, and so is codcov (maybe)
+TODO: codecov
+
+
+## Branching and PRs
+- Users that have been added to the CellMap organization and the DaCapo project should be able to develop directly into the CellMap fork of DaCapo. Other users will need to create a fork.
+- For a completely new feature, make a branch off of the `main` branch of CellMap's fork of DaCapo with a name describing the feature. If you are collaborating on a feature that already has a branch, you can branch off that feature branch.
+- Currently, you should make your PRs into the main branch of CellMap's fork, or the feature branch you branched off of. Once the PR is merged, the feature branch should be deleted. 
diff --git a/README.md b/README.md
index 64d35064a..5902959e5 100644
--- a/README.md
+++ b/README.md
@@ -16,3 +16,25 @@ on arbitrarily large volumes of
 multi-dimensional images. `dacapo` is not tied to a particular learning
 framework, but currently only supports [`torch`](https://pytorch.org/) with
 plans to support [`tensorflow`](https://www.tensorflow.org/).
+
+## Installation and Setup
+Currently, only python 3.10 is supported. We recommend creating a new conda environment for dacapo with python 3.10.
+```
+conda create -n dacapo python=3.10
+```
+
+Then clone this repository, go into the directory, and install:
+```
+git clone git@github.com:janelia-cellmap/dacapo.git
+cd dacapo
+pip install .
+```
+This will install the minimum required dependencies. However, having acess to a MongoDB server for storing outputs is strongly recommended for smoothest performance.
+
+To install and run MongoDB locally, refer to the MongoDB documentation [here](https://www.mongodb.com/docs/manual/installation/).
+
+## Functionality Overview
+
+Tasks we support
+
+Networks we have for those tasks