Skip to content

Commit

Permalink
Add GitHub documentation and PR template (#387)
Browse files Browse the repository at this point in the history
* Create CONTRIBUTING.md

* Update CONTRIBUTING.md

* Create BUILD.md

* Update BUILD.md

* Create configure.ps1

* Fix configuration script. Fix typos in BUILD.md. Add textMeshPro package.

* Create pull_request_template.md

* Update feature_request.md

* Add disclaimer, licence, and notice files.

* Rewrite README.md and update BUILD.md with images.

* Fix typo in link in README.md

* Add licence information to source files.

* Update Configure.ps1 with new links

* Update configure script to import all packages, no expansion needed.

* Update FeatureSetRenderer with some documentation.

* Fix off by one issues when updating feature outlines in VolumeDataSet.cs

* Add IDIA logo. Update Zenodo link.

* Add multidisciplinary to header. Add publications library link. Update zenodo badge.

* Add discussion links to readme

* Add lines about claiming issues, and unlabeled issues and feature requests.

* Fix default debug log file name.

* Fix README.md link

* Added changes to main README

* Fixed links for embedded images

* Add INAF to copyright notices

* Added copyright to NOTICE file

* Update README.md with Lucia's description

---------

Co-authored-by: Alex Sivitilli <alexandersivitilli@gmail.com>
  • Loading branch information
Pietersielie and CosmicElysium authored Oct 1, 2024
1 parent 0938e6f commit 19d1fe6
Show file tree
Hide file tree
Showing 121 changed files with 3,061 additions and 106 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Feature request
about: Suggest a new feature for iDaVIE-v
about: Suggest a new feature for iDaVIE
title: '[FR] "New Feature Request"'
labels: enhancement
assignees: ''
Expand Down
5 changes: 5 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Resolves #[Issue number]
### Changes:
- Change 1...
- Change 2...
- Change 3...
Binary file added .github/static/IDIA_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/static/INAF_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/static/Vislab_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/static/build.md/Build_Build_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/static/build.md/Build_Build_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/static/build.md/Build_Build_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/static/build.md/Build_SteamVRInput_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/static/build.md/Build_SteamVRInput_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/static/iDaVIE_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions Assets/Scripts/CatalogData/CatalogDataSet.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using System;
using System.Collections.Generic;
using System.Globalization;
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/CatalogData/CatalogDataSetManager.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using UnityEngine;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using UnityEngine;

namespace CatalogData
{
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/CatalogData/CatalogDataSetRenderer.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using System;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/CatalogData/CatalogInputController.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using System;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using System;
using System.Collections.Generic;
using CatalogData;
using LineRenderer;
Expand Down
21 changes: 21 additions & 0 deletions Assets/Scripts/CatalogData/ColumnInfo.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using System;

namespace CatalogData
Expand Down
21 changes: 21 additions & 0 deletions Assets/Scripts/CatalogData/DataMapping.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using System;
using System.IO;
using UnityEngine;
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/Debuggers/DebugLogging.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using SFB;
using System;
using System.Collections;
Expand Down Expand Up @@ -126,7 +147,7 @@ void saveToFileClick()
new ExtensionFilter("All Files", "*"),
};

StandaloneFileBrowser.SaveFilePanelAsync("Save log file", lastPath, "i-DaVIE_Debug.log", extensions, (string dest) =>
StandaloneFileBrowser.SaveFilePanelAsync("Save log file", lastPath, "iDaVIE_Debug.log", extensions, (string dest) =>
{
if (dest.Equals(""))
return;
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/Debuggers/FitsReaderDebug.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using AOT;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using AOT;
using System;
using System.Runtime.InteropServices;
using UnityEngine;
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/Editor/CatalogDataSetManagerEditor.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using UnityEngine;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using UnityEngine;
using CatalogData;
using UnityEditor;

Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/Editor/FeatureSetManagerEditor.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using UnityEngine;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using UnityEngine;
using System.Collections;
using DataFeatures;
using UnityEditor;
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/Editor/FeatureSetRendererEditor.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using UnityEngine;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using UnityEngine;
using System.Collections;
using DataFeatures;
using UnityEditor;
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/Editor/VolumeCommandControllerEditor.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using UnityEngine;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using UnityEngine;
using System.Collections;
using VolumeData;
using UnityEditor;
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/Editor/VolumeInputControllerEditor.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using UnityEditor;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using UnityEditor;
using UnityEngine;

[CustomEditor(typeof(VolumeInputController))]
Expand Down
23 changes: 22 additions & 1 deletion Assets/Scripts/FeatureData/Feature.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
using LineRenderer;
/*
* iDaVIE (immersive Data Visualisation Interactive Explorer)
* Copyright (C) 2024 IDIA, INAF-OACT
*
* This file is part of the iDaVIE project.
*
* iDaVIE is free software: you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License (LGPL) as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* iDaVIE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with
* iDaVIE in the LICENSE file. If not, see <https://www.gnu.org/licenses/>.
*
* Additional information and disclaimers regarding liability and third-party
* components can be found in the DISCLAIMER and NOTICE files included with this project.
*
*/
using LineRenderer;
using UnityEngine;

namespace DataFeatures
Expand Down
Loading

0 comments on commit 19d1fe6

Please # to comment.