Update documentation
This commit is contained in:
parent
ce6e88a347
commit
98d2d92b49
|
@ -633,7 +633,7 @@ dependencies = [
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "plate-tool-lib"
|
name = "plate-tool-lib"
|
||||||
version = "0.4.0"
|
version = "0.4.1"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"csv",
|
"csv",
|
||||||
"getrandom",
|
"getrandom",
|
||||||
|
|
26
README.md
26
README.md
|
@ -1,6 +1,6 @@
|
||||||
# plate-tool
|
# plate-tool
|
||||||
|
|
||||||
A web-based tool for creating assays for your favorite (acoustic) liquid handler.
|
A web-based tool for creating and visualizing picklists for your favorite (possibly acoustic) liquid handler.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
- [Usage](#Usage)
|
- [Usage](#Usage)
|
||||||
|
@ -61,8 +61,20 @@ To add a new plate, click the "New Plate" button:
|
||||||
To do so, first note the "File" tab at the top-left of the screen (above the list pane).
|
To do so, first note the "File" tab at the top-left of the screen (above the list pane).
|
||||||
Mouse over this tab, and a few more options will be revealed.
|
Mouse over this tab, and a few more options will be revealed.
|
||||||
We want to export: mouse over export and select "Export as CSV".
|
We want to export: mouse over export and select "Export as CSV".
|
||||||
You will be reminded that this is a one-way export (see JSON export/import below),
|
You will be prompted by your browser to select a location for your file.
|
||||||
and then prompted by your browser to select a location for your file.
|
|
||||||
|
As of version `0.4.0`, it is possible to pick a CSV export format:
|
||||||
|
Mouse over options, then export, then click "Change CSV export type".
|
||||||
|
In the dialog that opens, select your desired export type.
|
||||||
|
Currently, plate-tool supports:
|
||||||
|
- Normal
|
||||||
|
- This format can be imported by Cellario's cherrypick hook.
|
||||||
|
- Echo Client
|
||||||
|
- This format is useful if you want to run a picklist directly from the
|
||||||
|
Echo Client software.
|
||||||
|
This will export just the transfers between the currently selected plates;
|
||||||
|
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.
|
Currently, it is not possible to export to a format produced by other similar software.
|
||||||
|
@ -110,6 +122,11 @@ To add a new plate, click the "New Plate" button:
|
||||||
Your browser's console may have guidance as to why parsing failed;
|
Your browser's console may have guidance as to why parsing failed;
|
||||||
plate-tool was probably expecting a different name for a column than was in your file.
|
plate-tool was probably expecting a different name for a column than was in your file.
|
||||||
|
|
||||||
|
_Note_: If you find a picklist that Cellario *can* import that plate-tool cannot,
|
||||||
|
please email me!
|
||||||
|
Odds are your picklist contains a weird edge case I've not considered,
|
||||||
|
and I would like to fix that!
|
||||||
|
|
||||||
### Other Neat Features
|
### Other Neat Features
|
||||||
|
|
||||||
#### Taking Pictures of Plates
|
#### Taking Pictures of Plates
|
||||||
|
@ -119,6 +136,7 @@ To add a new plate, click the "New Plate" button:
|
||||||
and deposit it in your clipboard for you.
|
and deposit it in your clipboard for you.
|
||||||
You can then paste this into PowerPoint, GIMP, or whereever else
|
You can then paste this into PowerPoint, GIMP, or whereever else
|
||||||
you want a pretty picture of a plate.
|
you want a pretty picture of a plate.
|
||||||
|
I hope this is helpful for arts and crafts.
|
||||||
|
|
||||||
_NOTE:_ I won't guarantee this feature will work in all contexts;
|
_NOTE:_ I won't guarantee this feature will work in all contexts;
|
||||||
it relies on your browser thinking that you have plate-tool open
|
it relies on your browser thinking that you have plate-tool open
|
||||||
|
@ -141,7 +159,7 @@ To add a new plate, click the "New Plate" button:
|
||||||
Plate tool is hosted [here](https://ilia.moe/cool-stuff/plate-tool/) for your convenience.
|
Plate tool is hosted [here](https://ilia.moe/cool-stuff/plate-tool/) for your convenience.
|
||||||
However, you're absolutely welcome to host your own instance (even locally).
|
However, you're absolutely welcome to host your own instance (even locally).
|
||||||
Here's how:
|
Here's how:
|
||||||
(_Note:_ ~~If you run Windows you're probably best off doing the following in WSL2~~ You're absolutely fine to install rustup in Powershell, and the subsequent steps should be very similar but likely with different filepaths.)
|
(_Note:_ If you run Windows you're absolutely fine to install rustup in Powershell, and the subsequent steps should be very similar but likely with different filepaths. I haven't personally validated this. )
|
||||||
|
|
||||||
1. Make sure you have a working Rust toolchain
|
1. Make sure you have a working Rust toolchain
|
||||||
1. Installing `rustup` is the easiest way to do this. See [their website](https://rustup.rs/),
|
1. Installing `rustup` is the easiest way to do this. See [their website](https://rustup.rs/),
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[package]
|
[package]
|
||||||
name = "plate-tool-lib"
|
name = "plate-tool-lib"
|
||||||
version = "0.4.0"
|
version = "0.4.1"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
|
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
Loading…
Reference in New Issue