diff options
author | Miguel Ángel Moreno <mail@migalmoreno.com> | 2023-07-26 19:25:41 +0200 |
---|---|---|
committer | Miguel Ángel Moreno <mail@migalmoreno.com> | 2023-07-26 19:25:41 +0200 |
commit | 5f732e3d039c9d9c316dd5fbbbc91bd015dd2659 (patch) | |
tree | a82e8cddc6b50dedf17d1571fc8723860438d4d8 | |
parent | 94a7130106e297d4595a52b342ee22a3f1f614cf (diff) |
doc: Update wording on Guix setup and configuration
-rw-r--r-- | README | 16 | ||||
-rw-r--r-- | README.md | 14 |
2 files changed, 15 insertions, 15 deletions
@@ -1,9 +1,9 @@ -# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*- +# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; after-save-hook: org-md-export-to-markdown; -*- #+OPTIONS: toc:nil num:nil * nyxt.el -=nyxt.el= consists of custom logic to interact with [[https://nyxt.atlas.engineer/][Nyxt]] from Emacs. In contrast to [[https://github.com/ag91/emacs-with-nyxt][emacs-with-nyxt]], it doesn't bundle any Nyxt configuration and only includes a couple of interactive helpers for some common Nyxt operations. Users are encouraged to use the entry point function =nyxt-run= to build their own functionality. +=nyxt.el= consists of custom logic to interact with [[https://nyxt.atlas.engineer/][Nyxt]] from Emacs. In contrast to [[https://github.com/ag91/emacs-with-nyxt][emacs-with-nyxt]], it doesn't bundle any Nyxt configuration for you by default. Instead, it aims at providing a rich feature set of custom interactive functions via the =nyxt-run= entry function. Contributions are welcome! -This package requires the [[https://github.com/joaotavora/sly][SLY]] Emacs package to interact with the underlying Nyxt Lisp image. If you're an [[https://github.com/ch11ng/exwm][EXWM]] user, you'll also have the ability to make commands focus on the corresponding Nyxt window for a more seamless experience. +This package requires the [[https://github.com/joaotavora/sly][SLY]] Emacs package to interact with the underlying Nyxt Lisp image. Optionally, if you're an [[https://github.com/ch11ng/exwm][EXWM]] user, you'll have the ability to make commands focus on the corresponding Nyxt window for a more seamless experience with the browser. To install the package, simply point to the package in your =load-path=. @@ -11,7 +11,7 @@ To install the package, simply point to the package in your =load-path=. (add-to-list 'load-path "/path/to/nyxt.el") #+end_src -The easiest way to contribute to this project is to use the [[https://guix.gnu.org/][GNU Guix]] package manager and start developing on the local checkout by invoking the following commands: +If you'd like to contribute to the package and get the project set up quickly, I suggest you install the [[https://guix.gnu.org/][GNU Guix]] package manager and start developing on the local checkout by invoking the following commands: #+begin_src sh cd /path/to/nyxt.el @@ -23,10 +23,10 @@ An example configuration might look like this: #+begin_src elisp (define-key global-map (kbd "C-c y") 'nyxt-map) (with-eval-after-load 'nyxt - (setopt nyxt-path (executable-find "guix")) - (setopt nyxt-startup-flags '("shell" "-D" "-f" "path/to/nyxt/build-scripts/nyxt.scm" "--" "path/to/nyxt/nyxt" "-e" "(start-slynk)"))) + (setq nyxt-path (executable-find "guix")) + (setq nyxt-startup-flags '("shell" "-D" "-f" "path/to/nyxt/build-scripts/nyxt.scm" "--" "path/to/nyxt/nyxt" "-e" "(start-slynk)"))) #+end_src -Above, we first set the default bindings included in the =nyxt-map= to the ~C-c y~ global binding. By default, this package will spawn a Nyxt process with the =-e (start-slynk)= flags so that it can launch and connect to a Slynk process. However, as shown above, you're free to modify the executable path and the flags supplied to it, such as if you're developing on Nyxt using the [[https://guix.gnu.org][GNU Guix]] package manager. +Above, we set the default bindings included in the =nyxt-map= to the ~C-c y~ global binding. By default, this package will spawn a Nyxt process with the =-e (start-slynk)= flags so that it can launch and connect to a Slynk process. However, you're free to modify the executable path and the flags supplied to it, such as if you're developing on Nyxt using the [[https://guix.gnu.org][GNU Guix]] package manager. -You can send feedback, patches, or bug reports to [[mailto:public@mianmoreno.com][public@mianmoreno.com]]. +Feel free to open an issue or send a pull request if you encounter a bug or wish to add a new feature. @@ -2,15 +2,15 @@ # nyxt.el -`nyxt.el` consists of custom logic to interact with [Nyxt](https://nyxt.atlas.engineer/) from Emacs. In contrast to [emacs-with-nyxt](https://github.com/ag91/emacs-with-nyxt), it doesn't bundle any Nyxt configuration and only includes a couple of interactive helpers for some common Nyxt operations. Users are encouraged to use the entry point function `nyxt-run` to build their own functionality. +`nyxt.el` consists of custom logic to interact with [Nyxt](https://nyxt.atlas.engineer/) from Emacs. In contrast to [emacs-with-nyxt](https://github.com/ag91/emacs-with-nyxt), it doesn't bundle any Nyxt configuration for you by default. Instead, it aims at providing a rich feature set of custom interactive functions via the `nyxt-run` entry function. Contributions are welcome! -This package requires the [SLY](https://github.com/joaotavora/sly) Emacs package to interact with the underlying Nyxt Lisp image. If you're an [EXWM](https://github.com/ch11ng/exwm) user, you'll also have the ability to make commands focus on the corresponding Nyxt window for a more seamless experience. +This package requires the [SLY](https://github.com/joaotavora/sly) Emacs package to interact with the underlying Nyxt Lisp image. Optionally, if you're an [EXWM](https://github.com/ch11ng/exwm) user, you'll have the ability to make commands focus on the corresponding Nyxt window for a more seamless experience with the browser. To install the package, simply point to the package in your `load-path`. (add-to-list 'load-path "/path/to/nyxt.el") -The easiest way to contribute to this project is to use the [GNU Guix](https://guix.gnu.org/) package manager and start developing on the local checkout by invoking the following commands: +If you'd like to contribute to the package and get the project set up quickly, I suggest you install the [GNU Guix](https://guix.gnu.org/) package manager and start developing on the local checkout by invoking the following commands: cd /path/to/nyxt.el guix shell --pure @@ -19,10 +19,10 @@ An example configuration might look like this: (define-key global-map (kbd "C-c y") 'nyxt-map) (with-eval-after-load 'nyxt - (setopt nyxt-path (executable-find "guix")) - (setopt nyxt-startup-flags '("shell" "-D" "-f" "path/to/nyxt/build-scripts/nyxt.scm" "--" "path/to/nyxt/nyxt" "-e" "(start-slynk)"))) + (setq nyxt-path (executable-find "guix")) + (setq nyxt-startup-flags '("shell" "-D" "-f" "path/to/nyxt/build-scripts/nyxt.scm" "--" "path/to/nyxt/nyxt" "-e" "(start-slynk)"))) -Above, we first set the default bindings included in the `nyxt-map` to the `C-c y` global binding. By default, this package will spawn a Nyxt process with the `-e (start-slynk)` flags so that it can launch and connect to a Slynk process. However, as shown above, you're free to modify the executable path and the flags supplied to it, such as if you're developing on Nyxt using the [GNU Guix](https://guix.gnu.org) package manager. +Above, we set the default bindings included in the `nyxt-map` to the `C-c y` global binding. By default, this package will spawn a Nyxt process with the `-e (start-slynk)` flags so that it can launch and connect to a Slynk process. However, you're free to modify the executable path and the flags supplied to it, such as if you're developing on Nyxt using the [GNU Guix](https://guix.gnu.org) package manager. -You can send feedback, patches, or bug reports to [public@mianmoreno.com](mailto:public@mianmoreno.com). +Feel free to open an issue or send a pull request if you encounter a bug or wish to add a new feature. |