Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.31 KB

README.md

File metadata and controls

65 lines (44 loc) · 2.31 KB
Raw

ARCitect

The ARCitect is an electron-app to create, manage and share your ARCs.

🚧 Note, that the ARCitect is currently being developed and not ready for standard users, yet. 🚧

Installation

It is only necesary to download and run one of the provided standalone Releases for Windows (suffix: win.zip), MacOS (suffix: dmg), and Linux (suffix: AppImage). The releases do not require you to install any dependencies (except git for the MacOS and Linux releases). For Linux you might need to make the file executable:

Make the file executable on Linux

(A) with the user interface
  • right-click the file and select properties
  • go to the "permissions" tab and tick the field "execute"
  • now double-clicking the AppImage should start the ARCitect
(B) from the command line (you might need specific rights for this)
  • open a terminal
  • move to the directory where you have saved your AppImage (e.g. Downloads)
cd Downloads
  • make the file executable (use the appropriate name of the file)
chmod u+x ARCitect-0.0.15.AppImage
  • now double-clicking the AppImage should start the ARCitect

Building from Source

To build ARCitect from source, you first need to clone this repository, then install its dependencies via npm, and finally start ARCitect via npm, i.e.,

git clone https://github.com/nfdi4plants/ARCitect
cd ARCitect
npm install
npm start

Contribution

The following quick guide is intended to help content contributors find a starting point.

Release

  1. Increase package.json semver.
  2. Any commit with release tag git tag <Placeholder>, where <Placeholder> must be equal to package.json version, will trigger release pipeline in GitHub actions.
  3. Push tag with git push --follow-tags

Issues

Feel free to raise an issue to let us know what feature is missing or if anything is buggy.

Help texts

Changes to the help texts can be adjusted in the corresponding document located in the following folder:

packages/renderer/src/docs

Images

Relevant images can be placed in the following folder:

packages/renderer/assets

💡 Images currently occupy 100% of the width of the help text window.