From 9d2e2d9f394124918c34494ee87bcceebe274914 Mon Sep 17 00:00:00 2001 From: Jordan Cook Date: Thu, 27 Jun 2024 10:57:50 -0500 Subject: [PATCH] Minor doc updates --- HISTORY.md | 2 +- README.md | 4 +--- docs/app.md | 4 ---- docs/installation.md | 8 ++++---- docs/reference.md | 5 +++-- 5 files changed, 9 insertions(+), 14 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 223c0fb6..bb5a8132 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -2,7 +2,7 @@ ## 0.8.0 (Unreleased) **UI:** -* Add tab for basic observation details +* Add tab for browsing user's observations * When an observation is selected, show a summary of basic observation details on main screen * Display observation count and leaf taxon count on taxon info cards * Add support for displaying and searching common names in any language supported by iNaturalist.org diff --git a/README.md b/README.md index 8b457c9c..86dd64a8 100644 --- a/README.md +++ b/README.md @@ -84,9 +84,7 @@ pip install naturtag ## Usage ### GUI -The main interface for this project is still a work in progress. - -It includes an interface for selecting and tagging images: +Naturtag is primarily a desktop application. It includes an interface for selecting and tagging images: ![Screenshot](assets/screenshots/image-selector.png) diff --git a/docs/app.md b/docs/app.md index 9f38cd1e..47512842 100644 --- a/docs/app.md +++ b/docs/app.md @@ -138,22 +138,18 @@ Key(s) | Action | Tab/Screen `Ctrl+R` | Run image tagger | Photos `Ctrl+Shift+R` | Run image tag refresh | Photos `Ctrl+X` | Clear selected images | Photos - | | `Ctrl+Enter` | Run search | Species `Ctrl+Shift+X` | Clear search fields | Species `Ctrl+Left` | View previous taxon | Species `Ctrl+Right` | View next taxon | Species `Alt+Up` | View parent taxon | Species - | | `F5` | Refresh observations | Observations `Ctrl+Left` | View previous page | Observations `Ctrl+Right` | View next page | Observations - | | `Left` | View previous image | Fullscreen image (local photo or taxon) `Right` | View next image | Fullscreen image (local photo or taxon) `Escape` | Exit fullscreen view | Fullscreen image (local photo or taxon) `Del` | Remove image from selection | Fullscreen image (local photo) - | | `Ctrl+Tab` | Cycle through tabs | All `Ctrl+Shift+F` | Add a directory to favorites| All `Ctrl+Shift+T` | Toggle toolbar visibility | All diff --git a/docs/installation.md b/docs/installation.md index 1a5568d1..33f29141 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,12 +1,12 @@ # {fa}`download` Installation -Package downloads can be found on [GitHub Releases](https://github.com/pyinat/naturtag/releases). +Downloads can be found on [GitHub Releases](https://github.com/pyinat/naturtag/releases). Platform-specific installation instructions are below: ```{warning} -These packages and installers are brand new, and not yet thoroughly tested on all platforms. -Please [create a bug report](https://github.com/pyinat/naturtag/issues/new) if you find any issues! +These packages and installers have not yet been thoroughly tested on all platforms. +Please [create a bug report](https://github.com/pyinat/naturtag/issues/new) if you encounter any installation issues! ``` ::::{tab-set} @@ -64,7 +64,7 @@ A Windows installer is available here: ## Python package -You can also install naturtag as a regular python package, if you prefer: +You can also use naturtag as a {ref}`plain python library `, if you prefer: * First, [install python 3.10](https://www.python.org/downloads/) if you don't have it yet. * It's recommended to install into a [virtual environment](https://docs.python.org/3/library/venv.html). * Install with `pip`: diff --git a/docs/reference.md b/docs/reference.md index 05d0648f..4559e5af 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,10 +1,11 @@ +(library)= # {fa}`list` API Reference This section documents all the modules included in naturtag. Many of these are internal modules, and likely only relevant if you are interested in contributing to naturtag. ## Main entry points -To use some of the features of naturtag in your own code, the following functions and classes are -the main entry points: +To use the core tagging features in your own code, the following functions and classes are the main +entry points: ```{eval-rst} .. currentmodule:: naturtag.metadata.inat_metadata