Skip to content

Commit

Permalink
Minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
JWCook committed Jun 30, 2024
1 parent 8de3da0 commit 9d2e2d9
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 14 deletions.
2 changes: 1 addition & 1 deletion HISTORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 0 additions & 4 deletions docs/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -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:

<!-- TODO: portable (.tar.gz) download links & instructions -->

```{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}
Expand Down Expand Up @@ -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 <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`:
Expand Down
5 changes: 3 additions & 2 deletions docs/reference.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 9d2e2d9

Please sign in to comment.