diff options
author | Miguel Ángel Moreno <mail@migalmoreno.com> | 2024-06-30 10:32:56 +0200 |
---|---|---|
committer | Miguel Ángel Moreno <mail@migalmoreno.com> | 2024-06-30 12:36:41 +0200 |
commit | 3db0a338b889860ba2947a413047d90c83205801 (patch) | |
tree | 4810b00d5e98e70a587f2c796e5b4313b742f3d9 | |
parent | 5c256cb27035aca461a00fab171c56780018bd98 (diff) |
doc: update README
-rw-r--r-- | README | 10 | ||||
-rw-r--r-- | README.md | 10 |
2 files changed, 6 insertions, 14 deletions
@@ -1,9 +1,7 @@ # -*- 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 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. 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. +=nyxt.el= consists of custom logic to interact with [[https://nyxt.atlas.engineer/][Nyxt]] from Emacs. In contrast to other similar packages, 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. This package requires the [[https://github.com/joaotavora/sly][SLY]] Emacs package to interact with the underlying Nyxt Lisp image. To install the package, simply point to the package in your =load-path=. @@ -11,7 +9,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 -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: +If you'd like to contribute to the package and get the project set up quickly, it's highly encouraged 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 @@ -27,6 +25,4 @@ An example configuration might look like this: (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 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. - -Feel free to open an issue or send a pull request if you encounter a bug or wish to add a new feature. +Above, we set the default bindings included in the =nyxt-map= to the ~C-c y~ global binding and we modify the executable path and the flags supplied to it. By default, this package will spawn a Nyxt process with the =-e (start-slynk)= flag so it can launch and connect to a Slynk process, but you're free to change these flags, such as if you're developing on Nyxt using [[https://guix.gnu.org/manual/en/html_node/Invoking-guix-shell.html][guix shell]]. @@ -2,15 +2,13 @@ # 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 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. 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. +`nyxt.el` consists of custom logic to interact with [Nyxt](https://nyxt.atlas.engineer/) from Emacs. In contrast to other similar packages, 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. This package requires the [SLY](https://github.com/joaotavora/sly) Emacs package to interact with the underlying Nyxt Lisp image. To install the package, simply point to the package in your `load-path`. (add-to-list 'load-path "/path/to/nyxt.el") -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: +If you'd like to contribute to the package and get the project set up quickly, it's highly encouraged 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 @@ -22,7 +20,5 @@ An example configuration might look like this: (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 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. - -Feel free to open an issue or send a pull request if you encounter a bug or wish to add a new feature. +Above, we set the default bindings included in the `nyxt-map` to the `C-c y` global binding and we modify the executable path and the flags supplied to it. By default, this package will spawn a Nyxt process with the `-e (start-slynk)` flag so it can launch and connect to a Slynk process, but you're free to change these flags, such as if you're developing on Nyxt using [guix shell](https://guix.gnu.org/manual/en/html_node/Invoking-guix-shell.html). |