wrote readme

This commit is contained in:
Robert Nasarek 2022-08-31 14:54:51 +02:00
parent 9b2b852c40
commit 76800ad933
2 changed files with 35 additions and 3 deletions

View file

@ -1,4 +1,35 @@
Document manager for germanic national museum # Marvin
[Boilerplate](https://github.com/alexdevero/electron-react-webpack-boilerplate.git) by [Alex Devero](https://github.com/alexdevero/) <div style="text-align: center;">
<img src="marvin.ico"/>
<p>
Document manager for Institute for Art Technology and Conservation at <a href="https://gnm.de" _targer="blank">Germanic National Museum Nuremberg </a>
</p>
</div>
## Description
Search object information for a given objectid at https://objektkatalog.gnm.de/rest_export/ and populate MS Word templates.
## Prerequisites
You need [nodejs](https://nodejs.org/en/) for running and building. You may want to install it with nvm ([windows](https://docs.microsoft.com/de-de/windows/dev-environment/javascript/nodejs-on-windows)/ [linux](https://github.com/nvm-sh/nvm)).
## Install
~~~sh
git clone https://github.com/rnsrk/marvin.git
cd marvin
npm i
~~~
## Usage
Start devServer
~~~sh
npm run start
~~~
Build Windows / Linux executable
~~~sh
npm run package
~~~
## Thanks
I've used the [Boilerplate](https://github.com/alexdevero/electron-react-webpack-boilerplate.git) by [Alex Devero](https://github.com/alexdevero/)

View file

@ -106,7 +106,8 @@ let mainMenu = Menu.buildFromTemplate(
bug_link_text: 'Einen Fehler melden', bug_link_text: 'Einen Fehler melden',
license: 'MIT', license: 'MIT',
description: 'App zur Dokumentverwaltung im IKK am Germanischen Nationalmuseum.', description: 'App zur Dokumentverwaltung im IKK am Germanischen Nationalmuseum.',
win_options: {title: 'Über Marvin'} win_options: {title: 'Über Marvin'},
homepage: 'https://github.com/rnsrk/marvin'
}) })
} }
} }