diff --git a/README.md b/README.md index c88b303..3ec695a 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,25 @@ A web-based tool for creating and visualizing picklists for your favorite (possibly acoustic) liquid handler. ## Table of Contents -- [Usage](#Usage) -- [Installation](#Installation) +- [Usage](#usage) + - [Plates](#plates) + - [Adding plates](#adding-plates) + - [Modifying plates](#modifying-plates) + - [Transfers](#transfers) + - [Adding a transfer](#adding-a-transfer) + - [Modifying transfers](#modifying-transfers) + - [Importing and Exporting](#importing-and-Exporting) + - [Export as CSV](#export-as-csv) + - [Export as JSON](#export-as-json) + - [Import from JSON](#import-from-json) + - [Import Transfer from CSV](#import-transfer-from-csv) + - [Other Neat Features](#other-neat-features) +- [Installation](#installation) ## Usage -### Adding plates +### Plates +#### Adding plates When you open plate tool for the first time, you'll be greeted by a message informing you that no plates are selected. @@ -18,14 +31,15 @@ Once you've added at least one source plate and one destination plate, click one of each to select them. The right-most pane will now display these plates. -### Modifying and deleting plates +#### Modifying plates Suppose you erroneously created a plate, or misspelled its name. Double click on that plate in the list (top-left pane) and a new modal will open. Here you can rename a plate or delete it. You may also change the format of a plate (note that this will not delete any data if you accidentally switch to a smaller format). -### Adding a transfer +### Transfers +#### Adding a transfer Now that you have two plates selected, it's time to add a transfer. We can see all of the properties of our transfer in the bottom-left pane. @@ -46,7 +60,7 @@ depending on the transfer type and interleave settings. When all of the settings are to your liking, click the "Save" button. Note that it now appears in the "Transfers" section of the list pane. -### Modifying and deleting transfers +#### Modifying transfers If you already saved a transfer and would like to change it, click on its entry in the list. Now change the properties of the transfer as you did during initial creation. @@ -76,7 +90,8 @@ Currently, plate-tool supports: I assume you'd be using this feature in a non-automation context and know to load your plates into your Echo yourself. -#### Export as JSON (Saving Your Work) +#### Export as JSON +##### (Saving Your Work) Currently, it is not possible to export to a format produced by other similar software. However, you might reasonably want to save a copy of your work either as a backup or to share. @@ -84,7 +99,8 @@ Mouse over the "File" tab, then "Export" as above, then alternatively select "Ex Your browser will then prompt you to pick a suitable location to save your work as a file. (See note 1 below) -#### Import from JSON (Recovering Your Work) +#### Import from JSON +##### (Recovering Your Work) If we want to import one such file, mouse over the "File" tab as before and select "Import", and finally click "Import from JSON". This opens a modal where you are prompted to upload (see note 2) @@ -106,7 +122,8 @@ You are welcome to verify (use your browser's developer tools, it should have a that this application does not "phone home". Your data is stored locally (unless you choose to export it and distribute it yourself). -#### Import Transfer from CSV (Using a picklist as a transfer) +#### Import Transfer from CSV +##### (Using a picklist as a transfer) If you have a CSV generated by another tool (or plate-tool), you can import it as a single transfer. To do so, mouse over the "File" tab, then "Import", and finally "Import Transfer from CSV".