diff --git a/README.md b/README.md new file mode 100644 index 0000000..3dbf436 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# App Workbench Shared Code Snippets + +This repository contains reusable code snippets designed to accelerate the development of custom applications within the **Application Workbench** on the EPISODES Platform. Use these snippets to enhance your projects by copying and integrating them directly into your application repositories. + +## Application Workbench + +The Application Workbench is a web interface for creating and managing GIT repositories, allowing users to build custom applications for data analysis and virtual experimentation. Learn more at the [Application Workbench](https://epos-apps.grid.cyfronet.pl/). + +## Purpose of This Repository + +The **Shared Snippets** repository aims to: +- Provide reusable and commonly used code snippets that can be integrated into user-created applications within the Application Workbench. +- Speed up the development process by offering ready-to-use code components. +- Encourage the sharing and reuse of useful code fragments among Workbench users. + +## How to Use Snippets + +1. **Browse**: Find a suitable snippet in the repository. +2. **Copy**: Copy the snippet code directly into your application’s codebase within the Application Workbench. +3. **Customize**: Modify the snippet if necessary to fit the specific requirements of your application. +4. **Check for Updates**: Regularly revisit this repository to see if there are any updates or improvements to the snippets you are using. Manually update your code as needed. +5. **Follow Guidelines**: Make sure to read any guidelines or comments within the snippet for proper integration. +6. **Review Licenses**: Always review the snippet’s license and ensure it complies with your application’s requirements. + +## Repository Structure +The repository is organized by programming languages to help you easily find the snippets relevant to your needs: + +- **`/matlab`** - MATLAB code snippets. +- **`/python`** - Python code snippets. + +## Contributing + +We welcome contributions to this repository! If you have a code snippet that could be useful to others, feel free to add it: + +1. Fork the repository. +2. Create a new branch for your snippet. +3. Add your snippet to the appropriate folder and include comments explaining its purpose and usage. +4. Submit a pull request with a brief description of your contribution. + +## Acknowledgements + +Developed with support from the EPOS-PL project (No POIR.04.02.00-14-A003/16), co-financed by the European Union from the European Regional Development Fund (ERDF). +