Skip to content

Commit

Permalink
docs: update top level README and remove unused legacy files (#4717)
Browse files Browse the repository at this point in the history
  • Loading branch information
b-cooper authored Jan 15, 2020
1 parent 7e728ea commit 3a57ad4
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 178 deletions.
1 change: 0 additions & 1 deletion .codecov.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
fixes:
- 'api/src/opentrons/::opentrons/'
ignore:
- 'architecture-and-planning'
- 'audio'
- 'compute'
- '**/node_modules'
Expand Down
6 changes: 0 additions & 6 deletions .dockerignore

This file was deleted.

72 changes: 0 additions & 72 deletions CLA.txt

This file was deleted.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ After your Pull Request is merged (or otherwise closed), you’ll want to make s

### Deciding What to Work On

If you're looking for something to work on, especially for a first contribution, check out [our list of easy issues][easyfix]. Be sure to drop a comment in the thread before starting work to make sure nobody else has picked it up. Also, to understand a bit more of the plans developed by the Opentrons software engineering team, see the [documentation on software architecture and plans](https://github.com/Opentrons/opentrons/tree/edge/architecture-and-planning).
If you're looking for something to work on, especially for a first contribution, check out [our list of easy issues][easyfix]. Be sure to drop a comment in the thread before starting work to make sure nobody else has picked it up.

## Commit Guidelines

Expand Down
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [Overview](#overview)
- [Opentrons API](#opentrons-api)
- [Opentrons App](#opentrons-app)
- [Contributing/Building](#contributing)
- [Contributing](#contributing)

## Overview

Expand All @@ -24,10 +24,11 @@ The Opentrons API is a simple framework designed to make writing automated biolo
We've designed it in a way we hope is accessible to anyone with basic computer and wetlab skills. As a bench scientist, you should be able to code your automated protocols in a way that reads like a lab notebook.

```python
pipette.aspirate(tube_1).dispense(tube_2)
pipette.aspirate(location=trough['A1'], volume=30)
pipette.dispense(location=well_plate['A1'], volume=30)
```

That is how you tell the Opentrons robot to pipette its max volume from one tube to another. Learn more here:
This example tells the Opentrons OT-2 to pipette 30 µL of liquid from a trough to well plate. Learn more here:

- [Documentation](http://docs.opentrons.com)
- [Source code](./api)
Expand All @@ -36,11 +37,20 @@ That is how you tell the Opentrons robot to pipette its max volume from one tube

Easily upload a protocol, calibrate positions, and run your experiment from your computer.

- [Download Here](https://opentrons.com/ot-app)
- [Documentation](https://support.opentrons.com/)
- [Source code](./app)

![ot-app](https://s3.amazonaws.com/opentrons-images/standalone/ot-2-app.png)

## Opentrons Protocol Designer

Easily create a protocol to run on your robot with this grapical tool.

- [Access Here](https://designer.opentrons.com/)
- [Documentation](https://intercom.help/opentrons-protocol-designer/)
- [Source code](./protocol-designer)

## Contributing

We love contributors! Here is the best way to work with us:
Expand Down
95 changes: 0 additions & 95 deletions architecture-and-planning/backend-architecture.md

This file was deleted.

Binary file removed audio/speaker-test.mp3
Binary file not shown.

0 comments on commit 3a57ad4

Please sign in to comment.