Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sk-ys committed Oct 30, 2023
1 parent d3b88c2 commit 1511a93
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# Redmine Issue Notes On Context Menu
This is a plugin for Redmine.
This is a plugin for Redmine.
This plugin adds a menu item to the existing context menu to display the issue notes dialog.
The dialog has `edit`, `delete` and `add` capabilities.

## Images
### View mode
![View mode](doc/view_mode.png)

### Edit mode
![Edit mode](doc/edit_mode.png)

## Supported Redmine Versions
Only Redmine `5.0.5` has been checked. Other versions have not been checked.

## Installation
### When using git

1. Clone this repository to your Redmine plugins directory.
```
cd [YOUR_REDMINE_DIRECTORY]/plugins
git clone https://github.com/sk-ys/redmine_issue_notes_on_context_menu.git
```
2. Restart Redmine.
### When not using git
1. Download zip file from the [release page](https://github.com/sk-ys/redmine_issue_notes_on_context_menu/releases) or the [latest main repository](https://github.com/sk-ys/redmine_issue_notes_on_context_menu/archive/refs/heads/main.zip).
2. Extract the ZIP file to your Redmine plugins directory. The name of the unzipped directory must be `redmine_issue_notes_on_context_menu`.
3. Restart Redmine.
## Using Libraries
### Google Material Symbols
Expand Down
Binary file added doc/edit_mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/view_mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1511a93

Please sign in to comment.