mirror of
https://github.com/nushell/nushell.git
synced 2024-11-24 01:13:37 +01:00
f378c72f6f
# Description This PR creates a `CITATION.cff` file. # User-Facing Changes Users will now be able to properly cite `nushell` when used e.g. in scientific work. The `CITATION.cff` file also enables users to get the citation withe the Github integration, see [documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files). More information about the `.cff` standard [here](https://citation-file-format.github.io/). # After Submitting Do you want it documented in the docs somewhere? If so, where exactly? Happy to make a PR there. One feature that could well be implemented later on is automatic updates to the CITATION file with a Github Action (this is outside of my comfort zone, so I'll leave that for a separate PR should anyone want to implement it). Ideally, the `CITATION.cff` file points to the latest release , and could do so with the following fields: ``` commit: version: date-released: ``` --------- Co-authored-by: Mikkel Roald-Arbøl <github.ggb9a@simplelogin.co> Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com> Co-authored-by: NotTheDr01ds <32344964+NotTheDr01ds@users.noreply.github.com>
27 lines
812 B
YAML
27 lines
812 B
YAML
cff-version: 1.2.0
|
|
title: 'Nushell'
|
|
message: >-
|
|
If you use this software and wish to cite it,
|
|
you can use the metadata from this file.
|
|
type: software
|
|
authors:
|
|
- name: "The Nushell Project Team"
|
|
identifiers:
|
|
- type: url
|
|
value: 'https://github.com/nushell/nushell'
|
|
description: Repository
|
|
repository-code: 'https://github.com/nushell/nushell'
|
|
url: 'https://www.nushell.sh/'
|
|
abstract: >-
|
|
The goal of the Nushell project is to take the Unix
|
|
philosophy of shells, where pipes connect simple commands
|
|
together, and bring it to the modern style of development.
|
|
Thus, rather than being either a shell, or a programming
|
|
language, Nushell connects both by bringing a rich
|
|
programming language and a full-featured shell together
|
|
into one package.
|
|
keywords:
|
|
- nushell
|
|
- shell
|
|
license: MIT
|