Commit Graph

254 Commits

Author SHA1 Message Date
Stefan Holderbach
22b375ccd4
Spell out our platform support policy (#10778)
This reflects how we currently distributed our efforts to supporting the
different platforms and clarifies which things get run by the Nushell
team and which rely on the help of third-parties or individual
contributors.

Feel free to propose improvements, as long as they can be backed up by
implemented practice as a result.
2023-10-20 11:35:16 +02:00
Antoine Stevan
dc3c34275d
add Direnv to the integrations (#10675)
related to
- https://github.com/direnv/direnv/pull/1175

# Description
this PR adds to the list of integrations of Nushell the new Direnv
section introduced in https://github.com/direnv/direnv/pull/1175
🥳

# User-Facing Changes

# Tests + Formatting

# After Submitting
2023-10-10 18:59:20 +02:00
Stefan Holderbach
5e951b2be9
Remove codecov.io setup (#10266)
As we currently don't run the coverage in CI and don't upload to
codecov.io remove the config to clean up the repo root.
2023-09-07 22:12:23 +02:00
Benjamin Lupton
535aec0648
readme: add dorothy to supported by (#10262)
Add Dorothy — https://github.com/bevry/dorothy — to the supported by
section. Dorothy is a dotfile ecosystem that enables a cross-shell and
cross-operating system dotfile experience. Allowing you to easily switch
to Nu, while keeping your existing env configuration, and allowing you
to write Nu commands that are accessible to other shells.

Dorothy  now has CI testing for its Nu integration.
2023-09-07 13:58:31 +02:00
Stefan Holderbach
1ee3bf784c
Tweak contributor image to include more users (#10238)
We previously had a limit of 500 users but we are well past that
2023-09-05 16:52:21 +02:00
Stefan Holderbach
5754f307eb
Remove "Progress" section from README (#9471)
I would personally propose to remove the progress board table from our
README.

At the stage where we are at right now with most items in a pre-stable
stage I don't think it is a good use of README real estate anymore. It
hasn't been updated in over 7 months for a single item and older than a
year for most boxes.

For upcoming users the list doesn't present detailed enough explanations
of potential pitfalls and may be more confusing by mentioning features
that are not really present (e.g. paging). Generally I have the
impression that the community generally helps raise awareness about the
limitations of the pre-1.0 state together with our release notes that
try to highlight the pace of breaking or evolving changes.

Potential users are probably best served by additional links to learn
more about our features and generally improved documentation and
community tutorials

For contributors that want to look for areas to help out, this view is
both not granular enough for real guidance and is maybe even actively
harmful in highlighting areas we don't prioritize for 1.0 stability
(e.g. notebook integration)

Contributors are probably better served by our planned write-ups around
the 1.0 roadmap and updating GitHub Kanban/project boards.
2023-06-19 18:50:40 +12:00
Stefan Holderbach
f5c39e29b4
Mention clap_complete_nushell in the officially supported section (#9468)
@nibon7 's https://github.com/nibon7/clap_complete_nushell has been
accepted into the official `clap` organization.

Seems to me worthy to be mentioned in the README
2023-06-18 19:49:33 -05:00
Justin Ma
74ba00a222
Try to add a nightly-build checking workflow (#9385)
# Description

Try to add a nightly-build workflow, relevant issue:
https://github.com/nushell/nushell/issues/9383

1. It will try to build the release binaries nightly at 3 am
1. It will create an issue like this:
https://github.com/hustcer/nu-release/issues/37 if the build fails
2. Add a Nightly Build status badge to README.md
2023-06-08 21:15:56 +08:00
Antoine Stevan
8eece32a8d
REFACTOR: clean the root of the repo (#9231)
# Description
i've almost always wanted to clean up the root of the repo, so here is
my take at it, with some important advice given by @fdncred 😌

- `README.release.txt` is now gone and directly inline in the
`release-pkg` script used in the `release` *workflow*
- `build.rs` has been moved to `scripts/` and its path has been changed
in
[`Cargo.toml`](https://github.com/amtoine/nushell/blob/refactor/clean-root/Cargo.toml#L3)
according to the [*Build Scripts*
section](https://doc.rust-lang.org/cargo/reference/build-scripts.html#build-scripts)
of *The Cargo Book*
- i've merged `images/` into `assets/` and fix the only mention to the
GIF in the README
- i've moved the `docs/README.md` inside the main `README.md` as a new
[*Configuration*
section](https://github.com/amtoine/nushell/tree/refactor/clean-root#configuration)
- the very deprecated `pkg_mgrs/` has been removed
- all the `.nu`, `.sh`, `.ps1` and `.cmd` scripts have been moved to
`scripts/`

### things i've left as-is
- all the other `.md` documents
- the configuration files
- all the Rust and core stuff
- `docker/`
- `toolkit.nu`
- the `wix/` diretory which appears to be important for `winget`

# User-Facing Changes
scripts that used to rely on the paths to some of the scripts should now
call the scripts inside `scripts/` => i think this for the greater good,
it was not pretty nor scalable to have a bunch of scripts in the root of
our main `nushell` 😱

*i even think we might want to move these scripts outside the main
`nushell` repo*
maybe to `nu_scripts` or some other tool 👍 

# Tests + Formatting
- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
-  `toolkit test`
-  `toolkit test stdlib`

# After Submitting
```
$nothing
```
2023-05-20 07:57:51 -05:00
Justin Ma
5fe0ca418d
Remove npm install instruction (#9022) 2023-04-27 18:44:51 +08:00
Justin Ma
07598c9620
Add npm installation instruction (#8982)
# Description

Add `npm` install instruction to README.md
2023-04-24 09:22:42 -05:00
Stefan Holderbach
b9808c8598
Reenable CI coverage (#8867)
# Description
Let's see if we don't run out of disk space as quickly again

This reverts commit 0e496f900d.
(#8677)



# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

# Tests + Formatting

Same coverage setup as before
2023-04-13 15:27:02 +12:00
JT
50ca77437d
Add atuin to official support (#8757)
# Description

_(Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.)_

_(Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.)_

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass
- `cargo run -- crates/nu-utils/standard_library/tests.nu` to run the
tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-04-05 13:08:32 -05:00
JT
0e496f900d
Remove CI coverage until we can figure out why it's broken (#8677)
# Description

The coverage testing on CI has been broken for at least a week. It looks
like we might have to do some work, but for now, disabling it so we
don't give bad stability info to contributors.

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass
- `cargo run -- crates/nu-utils/standard_library/tests.nu` to run the
tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-03-31 06:49:26 +13:00
Michael Angerman
bc54930bc6
one more try on readme (#8659)
# Description

Take 2...

_(Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.)_

_(Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.)_

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-03-28 22:19:33 -07:00
Michael Angerman
0d6e43097d
Add the showcase repo to Readme.md to give it more exposure to our developers (#8658)
# Description

The showcase repo has some cool material in it that I think is valuable
for our readers developers. Giving it a bit more exposure by putting it
our Readme will allow more folks to know this is yet another valuable
resource. I learned about this today from Darren and thought it would be
good to allow others the same opportunity to find it easier as well...

_(Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.)_

_(Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.)_

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-03-28 22:12:07 -07:00
Stefan Holderbach
0a1af85200
Fix codecov badge (#8279) 2023-03-02 06:34:12 +13:00
Stefan Holderbach
728e95c52b
Add links to the remaining README badges (#8191)
Quicklinks to metrics. When we are proud to display them as badges,
let's show of the underlying statistics as well. Also helpful to quickly
get to the actions.
2023-02-24 12:58:44 +01:00
Darren Schroeder
68ad854b0d
update link to command reference (#8111)
# Description

Broken link

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2023-02-18 07:38:36 -06:00
JT
64b6c02a22
Add codecov badge 2023-02-12 08:39:37 +13:00
TornaxO7
c4818d79f3
adding link to list of nu-plugins (#7649)
Co-authored-by: Stefan Holderbach <sholderbach@users.noreply.github.com>
2023-01-03 13:50:21 +01:00
Jérémy Audiger
f3d2be7a56
doc: correct some really tiny typos. (#7635) 2022-12-30 13:18:28 +01:00
JT
fdd92b2dda
Update README.md 2022-12-16 18:50:37 +13:00
JT
cfb0f3961b
Simple README updates (#7279)
# Description

_(Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.)_

_(Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.)_

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
2022-11-30 08:10:11 +13:00
JT
58d960d914
Update README re: typechecking (#7094) 2022-11-11 15:16:10 +13:00
Jakob Endler
378248341e
Update README.md (#6782)
Fixed a very small inconsistency.
2022-10-17 06:23:11 -05:00
Justin Ma
43a218240c
Add setup-nu link in README.md (#5763) 2022-06-13 17:40:38 +08:00
Darren Schroeder
837f0463eb
updated Dir to dir 2022-06-07 14:58:23 -05:00
Reilly Wood
56f6f683fc
Clean up README (#5718)
* Clean up README

* Update CONTRIBUTING.md

* Another pass over the README. Table of contents, more install info

* add a little extra features definition

* fix Winget instructions

* Change winget instructions to nushell (easier to remember)

Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com>
2022-06-07 12:47:08 -07:00
Justin Ma
1bcb87c48d
Update rust version (#5432) 2022-05-04 13:56:31 +12:00
Darren Schroeder
f6b99b2d8f
update build status badge (#5321) 2022-04-24 16:28:54 -05:00
Darren Schroeder
3eb447030b
update contrib to max=500 (#5317) 2022-04-24 13:03:20 -05:00
Darren Schroeder
2a18206771
add virtualenv to integrations (#5280) 2022-04-21 06:50:32 -05:00
Darren Schroeder
6a1378c1bb
Update README.md 2022-04-15 05:27:42 -05:00
Darren Schroeder
56af7e8d5f
tweak badge (#5187)
added `?branch=main?event=push` to see if it makes any difference.
2022-04-14 06:48:17 -05:00
Stefan Holderbach
1f6e0255c0
Fix typo in link (#5168)
skip-checks:true
2022-04-12 22:13:40 +02:00
JT
b61af9a26a
Update README.md 2022-04-13 06:24:46 +12:00
JT
6e2f6c71fe
Update README.md 2022-04-13 06:15:34 +12:00
JT
f51d5789a3
Update README.md 2022-04-13 06:15:09 +12:00
JT
933cee27ae
Update README.md 2022-04-13 06:12:33 +12:00
Felix Rath
0c9dd6a29a
Update README.md for Rust 1.59 (#4995)
Since `Cargo.toml` now specifies `strip = ...`, and `strip` is only available in cargo >=1.59, specify that at least this version is required.
2022-03-28 07:28:04 +13:00
Justin Ma
ae7c0b1097
Fix broken link in readme, should close #4776 [ci skip] (#4778) 2022-03-08 06:30:11 -05:00
dgalbraith
eeef9f27eb
Add installation instructions using Chocolatey (#4714)
Add installation instructions for Nushell on Windows using the
Chocolatey package manager.
2022-03-03 15:26:06 -06:00
zkldi
c6a3066103
Document Visual C++ requirement on Windows. (#4641)
Should fix #4563.
2022-02-25 13:04:10 -05:00
JT
da42100374
Update README.md 2022-02-18 20:30:58 -05:00
JT
dfc478e074
Update README.md 2022-02-18 20:30:23 -05:00
JT
3576350b4b
Update README.md 2022-02-13 07:57:38 -05:00
JT
b16e72f0a5
Update README.md 2022-02-08 13:59:08 -05:00
JT
56ba57c74a
Update README.md 2022-02-08 13:57:40 -05:00
JT
cdc8e67d61
Remove unused repo parts (#4271)
* Remove unused repo parts

* Update README

* cargo fmt
2022-01-26 07:31:04 +11:00