From f5e79d0227caf3424ed96634c251816d1ad89c07 Mon Sep 17 00:00:00 2001 From: Matthias Bodenbenner <matthias.bodenbenner@wzl-iqs.rwth-aachen.de> Date: Wed, 27 Nov 2024 10:28:54 +0100 Subject: [PATCH] wrote minimal readme --- README.md | 51 +++++++++++++++------------------------------------ 1 file changed, 15 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 79291fc..cc76b7a 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,25 @@ -# Getting Started with Create React App +# SOIL Editor -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), using the [Redux](https://redux.js.org/) and [Redux Toolkit](https://redux-toolkit.js.org/) TS template. +Web-based user interface for intuitively defining interface descriptions of _FAIR Sensor Services_ using the _Sensor Interfacing Language (SOIL)_. The UI provides a textual and visual editor for defining _SOIL_ models. -## Available Scripts +The editor is deployed at https://purl.org/soil/editor. -In the project directory, you can run: +The current version supports [SOIL 2.3.0](https://doi.org/10.5281/zenodo.12571237) by wrapping the [SOIL Workbench V 2.3.1](https://doi.org/10.5281/zenodo.13922911). -### `npm start` +## Citation -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +If you use this software please cite as: -The page will reload if you make edits.\ -You will also see any lint errors in the console. +Matthias Bodenbenner, André Fugmann, Julian Giesen, Robert H. Schmitt +**_SOIL Editor_** +Software, V1.0.0, Zenodo, 2024. +https://doi.org/10.5281/zenodo.13922935 -### `npm test` +## References -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +[Bodenbenner, Matthias](mailto:matthias.bodenbenner@wzl-iqs.rwth-aachen.de), Robert H. Schmitt. 27.06.2024. Description and Manual of the Sensor Interfacing Language (2.3.0). Zenodo. https://doi.org/10.5281/zenodo.12571237 -### `npm run build` +## Acknowledgements +Funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under Germany's Excellence Strategy – EXC-2023 Internet of Production – 390621612. -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). +Funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under Project-ID 432233186 -- AIMS. \ No newline at end of file -- GitLab