From bfa1fef9d8d796cf34293f74638fa19ba257bf43 Mon Sep 17 00:00:00 2001 From: Emilia Date: Tue, 13 Feb 2024 18:23:22 -0500 Subject: [PATCH] update readme --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 544a896..af35af1 100644 --- a/README.md +++ b/README.md @@ -78,13 +78,6 @@ To add a new plate, click the "New Plate" button: Keep in mind that this will overwrite any work you currently have open, so you may wish to export first (see above). - #### 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". - When creating transfers via this method, the transfer cannot be edited. - This is useful if you have a pre-existing picklist that you would like to visualize in plate-tool. - _Note 1_: JSON files are plaintext! By default there is little whitespace (this makes comprehending them a challenge) but if we pass it through a "JSON Beautifier" (enter this into your search engine of choice) @@ -99,6 +92,18 @@ To add a new plate, click the "New Plate" button: 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) + 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". + When creating transfers via this method, the transfer cannot be edited. + This is useful if you have a pre-existing picklist that you would like to visualize in plate-tool. + + _Note_: If you try to use this feature and no plates are available to select, + there was likely an issue parsing your picklist. + 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. + ### Other Neat Features #### Taking Pictures of Plates @@ -130,7 +135,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. However, you're absolutely welcome to host your own instance (even locally). Here's how: -(_Note:_ If you run Windows you're probably best off doing the following in WSL2) +(_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.) 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/), @@ -140,7 +145,7 @@ Here's how: 2. Install [trunk](https://trunkrs.dev/) - Run `cargo install --locked trunk` 3. Clone this repository using git -4. Enter the project directory and run `trunk serve` +4. Enter the plate-tool-web directory and run `trunk serve` - You may need to check where `cargo` is installing binaries by default. For me, they're at `~/.cargo/bin`. If trunk is not automatically placed in your path, you would then run `/your/path/to/.cargo/bin/trunk serve`. - You can instead run `trunk build --release` for a more performant binary.