From 40979a6d6a701d5b6c9b178a63488a66228b1afb Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sat, 27 Apr 2024 16:04:09 +0300 Subject: [PATCH] docs: clean up remaining mentions of neovim-flake --- .github/README.md | 128 ++---- .github/assets/LICENSE | 395 ++++++++++++++++++ ...-flake-logo-work.svg => nvf-logo-work.svg} | 0 LICENSE | 2 +- docs/manual/hacking/guidelines.md | 4 +- .../installation/modules/home-manager.md | 2 +- docs/manual/installation/modules/nixos.md | 2 +- 7 files changed, 439 insertions(+), 94 deletions(-) create mode 100644 .github/assets/LICENSE rename .github/assets/{neovim-flake-logo-work.svg => nvf-logo-work.svg} (100%) diff --git a/.github/README.md b/.github/README.md index cd34e6e..a0d8dd4 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,37 +1,37 @@
- neovim-flake Logo + nvf Logo
-

❄️ neovim-flake

+

❄️ nvf

- - Latest release + + Latest release - - Last commit + + Last commit - - License + + License - - Stars + + Stars - - Issues + + Issues - - Repo Size + + Repo Size

- +

A highly modular, configurable, extensible and easy to use Neovim configuration - wrapper written in Nix. Designed for flexibility and ease of use, this flake + framework in Nix. Designed for flexibility and ease of use, this flake allows you to easily configure your Neovim instance with a few lines of Nix code. @@ -69,7 +69,7 @@ If you would like to try out the configuration before even thinking about installing it, you can run the following command ```console -nix run github:notashelf/neovim-flake +nix run github:notashelf/nvf ``` This will get you a feel for the base configuration and UI design. @@ -81,7 +81,7 @@ It is as simple as changing the target output to get a different configuration. For example, to get a configuration with `tidal` support, run: ```console -nix run github:notashelf/neovim-flake#tidal +nix run github:notashelf/nvf#tidal ``` Similar instructions will apply for `nix profile install`. However, you are @@ -93,33 +93,18 @@ recommended to instead use the module system as described in the manual. > configurations. Should you choose to try out the `maximal` configuration, > using the binary cache as described in the manual is _strongly_ recommended. -### Docker - -As of version 0.5, an image for the `nix` output is published to Dockerhub -and GitHub packages with each tagged release. If you do not have Nix installed -on your system, you may run neovim within a container using your favorite tool. -The following command will open the current directory in neovim with necessary -tools bootstrapped. - -```console -docker run -v `pwd`:/home/neovim/demo --rm -it notashelf/neovim-flake:latest -``` - -The available registeres are `ghcr.io` and `dockerhub` for the time being. -Adjust to your liking. - ## Documentation -See the [neovim-flake Manual](https://notashelf.github.io/neovim-flake/) for +See the [**nvf** Manual](https://notashelf.github.io/nvf/) for detailed installation guides, configurations, available options, release notes and more. Tips for installing userspace plugins is also contained in the documentation. -If you want to dive right into trying **neovim-flake** you can get a fully +If you want to dive right into trying **nvf** you can get a fully featured configuration with `nix` language support by running: ```console -nix run github:notashelf/neovim-flake +nix run github:notashelf/nvf#nix ``` Please create an issue on the [issue tracker](../../../issues) if you find @@ -140,62 +125,21 @@ submitting a pull request. You can also create an issue on the [issue tracker](../../../issues) before submitting a pull request if you would like to discuss a feature or bug fix. -## Philosophy - -The philosophy behind this flake configuration is to create an easily -configurable and reproducible Neovim environment. While it does sacrifice in -size (which I know some users will find _disagreeable_), it offers a lot of -flexibility and customizability in exchange for the large size of the flake -inputs. The "KISS" (Keep it simple, stupid) principle has mostly been abandoned -here, however, you _can_ ultimately leverage the flexibility of this flake to -declare a configuration that follows KISS principles, as it is very easy to -bring your own plugins and configurations from non-nix. What this flake is -meant to be does eventually fall into your hands. Whether you are a developer, -writer, or live coder, you can quickly craft a config that suits every project's -needs. Think of it like a distribution of Neovim that you have full control over. - -A distribution that takes advantage of pinning vim plugins and third party -dependencies (such as tree-sitter grammars, language servers, and more). - -One should never get a broken config when setting options. If setting multiple -options results in a broken Neovim, file an issue! Each plugin knows when another -plugin which allows for smart configuration of keybindings and automatic setup -of things like completion sources and languages. - ## FAQ -**Q**: Why is this flake so big? -
-**A**: I have sacrificed in size in order to provide a highly configurable and -reproducible Neovim environment. A binary cache is provided to eleminate the -need to build the flake from source, but it is still a large flake. If you do -not need all the features, you can use the default `nix` output instead of the -`maximal` output. This will reduce size by a lot, but you will lose some -language specific features. -

- -**Q**: Will you try to make this flake smaller? -
-**A**: Yes. As a matter of fact, I am actively working on making this flake -smaller. Unfortunately the process of providing everything possible by itself -makes the flake large. Best I can do is to optimize the flake as much as -possible by selecting plugins that are small and fast. And the binary cache, so -at least you don't have to build it from source. -

- -**Q**: Will you use a plugin manager/language server installer? -
-**A**: No. If you feel the need to ask that question, then you have missed the -whole point of using nix and ultimately this flake. The whole reason we use nix -is to be able to handle EVERYTHING declaratively, well including the LSP and -plugin installations. -

- **Q**: Can you add _X_?
-**A**: Maybe. Open an issue using the appropriate template and I will consider -it. I do not intend to add _every plugin that is in existence_, but I will -consider it, should it offer something useful to the flake. +**A**: Maybe! It is not one of our goals to support each and every Neovim +plugin, however, I am always open to new modules and plugin setup additions +to **nvf**. Use the [appropritate issue +template](https://github.com/NotAShelf/nvf/issues/new/choose) and I will +consider a module addition. + +**Q**: A plugin I need is not available in **nvf**. What to do? +
+**A**: **nvf** exposes several APIs for you to be able to add your own +plugin configurations! Please see the documentation on how you may do +this. ## Credits @@ -207,7 +151,7 @@ Special thanks to - [@FlafyDev](https://github.com/FlafyDev) - For getting the home-manager to work - [@n3oney](https://github.com/n3oney) - For making custom keybinds finally possible - [@horriblename](https://github.com/horriblename) - For actively implementing planned features and quality of life updates -- [@Yavko](https://github.com/Yavko) - For the amazing neovim-flake logo +- [@Yavko](https://github.com/Yavko) - For the amazing **nvf** logo - [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I could not and everyone who has submitted issues or pull requests! @@ -226,4 +170,10 @@ I am grateful for their previous work and inspiration, and I wholeheartedly recommend checking their work out.
+## License + +Following the [original neovim-flake](https://github.com/jordanisaacs/neovim-flake) +**nvf** has been made available under the **MIT License**. However, all assets +are published under the [CC BY License]. + --- diff --git a/.github/assets/LICENSE b/.github/assets/LICENSE new file mode 100644 index 0000000..10fabd9 --- /dev/null +++ b/.github/assets/LICENSE @@ -0,0 +1,395 @@ +Attribution 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public licenses. +Notwithstanding, Creative Commons may elect to apply one of its public +licenses to material it publishes and in those instances will be +considered the “Licensor.” The text of the Creative Commons public +licenses is dedicated to the public domain under the CC0 Public Domain +Dedication. Except for the limited purpose of indicating that material +is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the public +licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/.github/assets/neovim-flake-logo-work.svg b/.github/assets/nvf-logo-work.svg similarity index 100% rename from .github/assets/neovim-flake-logo-work.svg rename to .github/assets/nvf-logo-work.svg diff --git a/LICENSE b/LICENSE index 342db3f..0e03fa9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 NotAShelf +Copyright (c) 2023-2024 NotAShelf Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/manual/hacking/guidelines.md b/docs/manual/hacking/guidelines.md index f90c02f..c709825 100644 --- a/docs/manual/hacking/guidelines.md +++ b/docs/manual/hacking/guidelines.md @@ -110,12 +110,12 @@ to contain the parent as well - for example `languages/java: some major change`. ## Code Style {#sec-guidelines-code-style} -### Treewide +### Treewide {#sec-code-style-treewide} Keep lines at a reasonable width, ideally 80 characters or less. This also applies to string literals and module descriptions and documentation. -### Nix +### Nix {#sec-code-style-nix} **nvf** is formatted by the [alejandra](https://github.com/kamadorueda/alejandra) tool and the formatting is checked in the pull request and push workflows. Run the diff --git a/docs/manual/installation/modules/home-manager.md b/docs/manual/installation/modules/home-manager.md index 0b80a10..6764f79 100644 --- a/docs/manual/installation/modules/home-manager.md +++ b/docs/manual/installation/modules/home-manager.md @@ -33,7 +33,7 @@ Followed by importing the home-manager module somewhere in your configuration. } ``` -## Example Installation {#sec-example-installation} +## Example Installation {#sec-example-installation-hm} ```nix { diff --git a/docs/manual/installation/modules/nixos.md b/docs/manual/installation/modules/nixos.md index 9be8a7f..9cbc144 100644 --- a/docs/manual/installation/modules/nixos.md +++ b/docs/manual/installation/modules/nixos.md @@ -33,7 +33,7 @@ Followed by importing the NixOS module somewhere in your configuration. } ``` -## Example Installation {#sec-example-installation} +## Example Installation {#sec-example-installation-nixos} ```nix {