From 2b1af9ae17e2e35a5b6dfef3bbbb330dade0a286 Mon Sep 17 00:00:00 2001 From: Nathan Young Date: Thu, 5 Oct 2023 15:26:12 -0400 Subject: [PATCH] BUG: Update .all-contributorsrc (#713) Update readme and all-contributors bot --- .all-contributorsrc | 14 +++++++------- README.md | 28 ++++++++++++++-------------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 035286c24c..88d7c5ad03 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -3,15 +3,15 @@ "projectOwner": "BlueQuartzSoftware", "repoType": "github", "repoHost": "https://github.com", - "files": ["README.md"], + "files": [ + "README.md" + ], "imageSize": 100, "commit": false, - "contributorsPerLine": 7, "contributorsSortAlphabetically": false, - "badgeTemplate": "[![All Contributors](https://img.shields.io/github/all-contributors/<%= projectOwner %>/<%= projectName %>?color=ee8449&style=flat-square)](#thank-you-to-our-wonderful-contributors)", - "contributorTemplate": "\">\" width=\"<%= options.imageSize %>px;\" alt=\"\"/>
<%= contributor.name %>", - "wrapperTemplate": "\n\n <%= bodyContent %> \n<%= tableFooterContent %>
\n\n", + "contributors": [] + "contributorsPerLine": 7, "linkToUsage": true, "skipCi": true, - "contributors": [] -} \ No newline at end of file + "commitConvention": "angular" +} diff --git a/README.md b/README.md index 99ba8b0813..c6176d71e2 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -# complex # +# complex -[![windows](https://github.com/BlueQuartzSoftware/complex/actions/workflows/windows.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/windows.yml) [![linux](https://github.com/BlueQuartzSoftware/complex/actions/workflows/linux.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/linux.yml) [![macos](https://github.com/BlueQuartzSoftware/complex/actions/workflows/macos.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/macos.yml) [![clang-format](https://github.com/BlueQuartzSoftware/complex/actions/workflows/format_push.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/format_push.yml) [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com) [![All Contributors](https://img.shields.io/github/all-contributors/BlueQuartzSoftware/complex?color=ee8449&style=flat-square)](#thank-you-to-our-wonderful-contributors) +[![windows](https://github.com/BlueQuartzSoftware/complex/actions/workflows/windows.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/windows.yml) [![linux](https://github.com/BlueQuartzSoftware/complex/actions/workflows/linux.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/linux.yml) [![macos](https://github.com/BlueQuartzSoftware/complex/actions/workflows/macos.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/macos.yml) [![clang-format](https://github.com/BlueQuartzSoftware/complex/actions/workflows/format_push.yml/badge.svg)](https://github.com/BlueQuartzSoftware/complex/actions/workflows/format_push.yml) [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com) [![All Contributors](https://img.shields.io/github/all-contributors/BlueQuartzSoftware/complex?color=ee8449&style=flat-square)](#contributors) -## Multilanguage README ## +## Multilanguage README | Language | [English](https://github.com/BlueQuartzSoftware/complex/blob/develop/README.md) | PlaceHolder | | -------- | ------------------------------------------------------------------------------- | ----------- | -## Introduction ## +## Introduction DREAM3D-NX is a user-friendly and versatile desktop application that leverages the open-source ‘complex’ software library to enable users to manipulate, analyze, and visualize multidimensional, multimodal data with ease. With its advanced reconstruction, quantification, meshing, data organization, and visualization capabilities, DREAM3D-NX has emerged as a go-to tool for the materials science community to reconstruct and quantify 3D microstructures. Its flexibility and adaptability make it suitable for a broad range of multidimensional data analysis applications beyond materials science and engineering domain. `complex` is a rewrite of the [SIMPL](https://www.github.com/bluequartzsoftware/simpl) library upon which [DREAM3D](https://www.github.com/bluequartzsoftware/dream3d) is written. This library aims to be fully C++17 compliant, removes the need for Qt5 at the library level and brings more flexible data organization and grouping options. The library is under active development by BlueQuartz Software at the current time. -## Project Vision ## +## Project Vision When the [DREAM3D](https://www.github.com/bluequartzsoftware/dream3d) project began in 2009, it was created with the goal of integrating the many disperate software codes in existance at the time under a single software framework. This software framework would allow these codes to define their requirements for input data, output data and required parameters in a common structure and thus enable the existing codes to ingest data from a previous code algorithm and produce output that the other code algorithms can readily utilize. By 2013 DREAM.3D had matured into a flexible desktop application that could peform a wide variety of materials science related processing. Over time, DREAM.3D’s capabilities expanded to include more generic data processing algorithms and image processing algorithms. The United States Government funded the entire development cycle for DREAM.3D and was gracious to allow the main project to be open sourced to allow it to penetrate into as many institutions as possible. In recent years the whole of DREAM3D and SIMPL were completely rewritten into DREAM3D-NX and the `complex` library. This new version focused on developing both maintainable and expandable software that enables a lower barrier to entry for contributions. The vision for the DREAM.3D project is to produce accessible software tools that are professionally developed, relentlessly tested, and maintained into the future thus accelerating current and future R&D efforts by building upon the contributors to the DREAM3D project. -## Public Release Notice ## +## Public Release Notice This software library is directly supported by USAF Contract _FA8650-22-C-5290_ and has been cleared as publicly releasable under the following: @@ -37,7 +37,7 @@ The material was assigned a clearance of CLEARED on 14 Sep 2022. This clearance is in effect until 14 SEPT 2025 at which point any new additions created under USAF funding should be cleared. Public additions through the normal PR process will not be affected. -## Get Help ## +## Get Help The current documentation is hosted at [dream3d.io docs](http://www.dream3d.io/nx_reference_manual/Index/). @@ -45,21 +45,21 @@ The current python binding instructions and documentation can be viewed at [drea See our [Support File](/SUPPORT.md) for more ways to get help! -## Building from Source ## +## Building from Source For instructions on building from source see our [Guide to Building From Source](/docs/Build_From_Source.md). -## Code of Conduct ## +## Code of Conduct By participating in this project, you are expected to uphold our [Code of Conduct](/CODE_OF_CONDUCT.md). If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting the project maintainers at [info@bluequartz.net](mailto:info@bluequartz.net). All reports will be handled with discretion. -## Community ## +## Community For those looking to engage with the DREAM3DNX community, see the discussions board of [DREAM3DNX-Issues discussions](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues/discussions). -## Contact Us ## +## Contact Us You can talk directly with developers in the [DREAM3DNX-Issues discussions](https://github.com/BlueQuartzSoftware/DREAM3DNX-Issues/discussions). @@ -67,7 +67,7 @@ If this doesn't work for you you can reach out to our team at our general addres See our [Support File](/SUPPORT.md) for more ways to contact us! -## Contribute ## +## Contribute Thanks so much for your interest in contributing to `complex`! @@ -79,9 +79,9 @@ The average response time for new pull requests is same-day if it's Monday-Thurs We deeply appreciate any and all contributions and that will absolutely be reflected in your interactions with active maintainers. -## Thank You to our Wonderful Contributors ## +## Contributors -Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): +Huge thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):