Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandermeindl committed Oct 5, 2024
1 parent 5edb25d commit 6644b55
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 30 deletions.
46 changes: 29 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,36 @@
HedgeDoc plugin for Redmine
===========================
# HedgeDoc plugin for Redmine

[![Rate at redmine.org](https://img.shields.io/badge/rate%20at-redmine.org-blue.svg?style=fla)](https://www.redmine.org/plugins/redmine_hedgedoc) [![Run Rubocop](https://github.com/AlphaNodes/redmine_hedgedoc/workflows/Run%20Rubocop/badge.svg)](https://github.com/AlphaNodes/redmine_hedgedoc/actions/workflows/rubocop.yml) [![Run Brakeman](https://github.com/AlphaNodes/redmine_hedgedoc/workflows/Run%20Brakeman/badge.svg)](https://github.com/AlphaNodes/redmine_hedgedoc/actions/workflows/brakeman.yml) [![Run Tests](https://github.com/AlphaNodes/redmine_hedgedoc/workflows/Tests/badge.svg)](https://github.com/AlphaNodes/redmine_hedgedoc/actions/workflows/tests.yml)

Features
--------
## Features

* Show list of own [HedgeDoc](https://hedgedoc.org/) pads in [Redmine](https://www.redmine.org/)
* Show HedgeDoc pads in [Redmine](https://www.redmine.org/) projects, if pad name has redmine identifier as prefix. Eg. MyProject: MyPad

Redmine Requirements
--------------------
## Redmine Requirements

* Redmine version >= 5
* Redmine Plugin: [additionals](https://github.com/alphanodes/additionals)
* Ruby version >= 2.7.0
* Ruby version >= 3.0

HedgeDoc Requirements
---------------------
## HedgeDoc Requirements

* HedgeDoc version: all
* E-Mail authentification

Installation
------------
## Installation

Install ``redmine_hedgedoc`` plugin for `Redmine`

cd $REDMINE_ROOT
git clone git://github.com/alphanodes/additionals.git plugins/additionals
git clone git://github.com/alphanodes/redmine_hedgedoc.git plugins/redmine_hedgedoc
bundle install --without development test
bundle update --without development test
bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Restart Redmine (application server) and you should see the plugin show up in the Plugins page.


Configuration
-------------
## Configuration

Redmine needs access to [HedgeDoc](https://hedgedoc.org/) database. Add in your config/database.yml an paragraph names "hedgedoc", e.g.

Expand All @@ -50,12 +43,31 @@ Redmine needs access to [HedgeDoc](https://hedgedoc.org/) database. Add in your
encoding: utf8
schema_search_path: public

Uninstall
---------
## Uninstall

Uninstall ``redmine_hedgedoc``

cd $REDMINE_ROOT
rm -rf plugins/redmine_hedgedoc

Restart Redmine (application server)

## License

This plugin is licensed under the terms of GNU/GPL v2.
See LICENSE for details.

## Redmine Copyright

The redmine_hedgedoc is a plugin extension for Redmine Project Management Software, whose Copyright follows.
Copyright (C) 2006- Jean-Philippe Lang

Redmine is a flexible project management web application written using Ruby on Rails framework.
More details can be found in the doc directory or on the official website <http://www.redmine.org>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 changes: 5 additions & 13 deletions test/unit/i18n_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,10 @@ def test_valid_languages
end

def test_locales_validness
lang_files_count = Rails.root.glob('plugins/redmine_hedgedoc/config/locales/*.yml').size
assert_equal lang_files_count, 2
valid_languages.each do |lang|
assert set_language_if_valid(lang)
case lang.to_s
when 'en'
assert_equal 'New HedgeDoc pad', l(:label_new_hedgedoc_pad)
when 'de'
assert_not l(:label_new_hedgedoc_pad) == 'New HedgeDoc pad', lang
end
end

set_language_if_valid 'en'
assert_locales_validness plugin: 'redmine_hedgedoc',
file_cnt: 2,
locales: %w[de],
control_string: :label_new_hedgedoc_pad,
control_english: 'New HedgeDoc pad'
end
end

0 comments on commit 6644b55

Please sign in to comment.