Skip to content

Commit

Permalink
added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gokulprathin8 committed Mar 25, 2024
1 parent 3f26595 commit 438eac5
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Geoweaver Application Tray

The Geoweaver Application Tray is a lightweight, efficient system tray application for managing the Geoweaver workflow management tool directly from your desktop. Geoweaver is designed to automate, record history, and manage complex scientific workflows, seamlessly integrating online spatial data facilities, high-performance computation platforms, and open-source libraries within web browsers.

This tray application enhances the Geoweaver experience by offering quick access functionalities such as launching, restarting, and quitting the Geoweaver application, making workflow management more accessible and streamlined for scientists and researchers.

## Features

- **Quick Launch**: Start the Geoweaver application directly from your system tray with just a click.
- **Easy Restart**: Restart the Geoweaver application without needing to manually close and reopen, ensuring a smooth workflow experience.
- **Convenient Quit**: Safely quit the Geoweaver application directly from the system tray, ensuring all processes are gracefully terminated.
- **Effortless Management**: Manage the Geoweaver application without the need to navigate through your file system or use command-line tools.

## Getting Started

### Prerequisites

- Java 11 or higher installed on your system.
- Go 1.15 or higher for compiling the source code.

### Installation

1. Clone this repository to your local machine:

```bash
git clone https://github.com/yourusername/geoweaver-application-tray.git
```

2. Navigate to the cloned directory:

```bash
cd geoweaver-application-tray
```

3. Build the application (ensure Go is installed and properly configured on your system):

```bash
go build
```

4. Run the built executable to launch the Geoweaver Application Tray.

### Usage

- **Launching Geoweaver**: Click on the Geoweaver icon in your system tray and select "Start Server" to launch the Geoweaver application.
- **Restarting Geoweaver**: Select "Restart Server" from the tray menu to restart the Geoweaver application.
- **Quitting Geoweaver**: Choose "Quit" from the tray menu to safely close the Geoweaver application.

## Contributing

Contributions to the Geoweaver Application Tray are welcome and appreciated. If you're interested in contributing, please read our [CONTRIBUTING.md](CONTRIBUTING.md) guide for more information on how to get started.

## License

This project is licensed under the [MIT License](LICENSE.md) - see the LICENSE file for details.

## Acknowledgments

- Our heartfelt gratitude to the Geoweaver community and all contributors to the Geoweaver project.
- Special thanks to [ESIPFed](https://github.com/ESIPFed/Geoweaver) for developing and maintaining Geoweaver.

---

Remember to replace placeholder links and text with actual content specific to your project. This template provides a basic structure for a professional README, including an introduction to the application, a features list, getting started instructions, a contribution guide, and licensing information. Adjust and expand each section to fit the unique aspects and requirements of your project.

0 comments on commit 438eac5

Please sign in to comment.