aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2023-07-18 15:42:57 +0200
committerMiguel Ángel Moreno <mail@migalmoreno.com>2023-07-18 15:42:57 +0200
commit44d37f07159e7bd5d3b045c74b2f704648de74af (patch)
treedc171e7faf4defacc177860751fe4b7b0bac9095
parenteff0b389cd7d04189db2c40be1c46125f0c5f3ef (diff)
doc: Update contribution methods and checkout source
-rw-r--r--README6
-rw-r--r--README.md4
2 files changed, 5 insertions, 5 deletions
diff --git a/README b/README
index af51454..b5575aa 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-# -*- 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
* nx-tailor
=nx-tailor= is a thin wrapper over the [[https://nyxt.atlas.engineer/][Nyxt]] built-in theme library (=nyxt/theme=). Its main purpose is to allow handling multiple themes inside a single browser session and to streamline theme selection on startup based on user configuration.
@@ -7,7 +7,7 @@
To install the extension, you should download the source and place it in Nyxt's extensions path, given by the value of =nyxt-source-registry= (by default =~/.local/share/nyxt/extensions=).
#+begin_src sh
-git clone https://git.mianmoreno.com/nx-tailor ~/.local/share/nyxt/extensions/nx-tailor
+git clone https://github.com/migalmoreno/nx-tailor ~/.local/share/nyxt/extensions/nx-tailor
#+end_src
The extension works with *Nyxt 3 onward* but it's encouraged to use it with the latest version of Nyxt master for the time being. It also requires you to use the [[https://www.sbcl.org/manual/][SBCL]] Common Lisp implementation to make use of the scheduling capabilities for automatic theme switching.
@@ -110,4 +110,4 @@ Now, if you want to tweak Nyxt's appearance further than its color palette by ch
By doing this, we'll allow =nx-tailor= to handle the styling of the interface element (=nyxt:status-buffer= in the above case).
** Contributing
-You can send feedback, patches, or bug reports to [[mailto:public@mianmoreno.com][public@mianmoreno.com]].
+Feel free to open an issue with bug reports or feature requests. PRs are more than welcome too.
diff --git a/README.md b/README.md
index 151a5dd..d8a71ed 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
To install the extension, you should download the source and place it in Nyxt's extensions path, given by the value of `nyxt-source-registry` (by default `~/.local/share/nyxt/extensions`).
- git clone https://git.mianmoreno.com/nx-tailor ~/.local/share/nyxt/extensions/nx-tailor
+ git clone https://github.com/migalmoreno/nx-tailor ~/.local/share/nyxt/extensions/nx-tailor
The extension works with **Nyxt 3 onward** but it's encouraged to use it with the latest version of Nyxt master for the time being. It also requires you to use the [SBCL](https://www.sbcl.org/manual/) Common Lisp implementation to make use of the scheduling capabilities for automatic theme switching.
@@ -102,5 +102,5 @@ By doing this, we'll allow `nx-tailor` to handle the styling of the interface el
## Contributing
-You can send feedback, patches, or bug reports to [public@mianmoreno.com](mailto:public@mianmoreno.com).
+Feel free to open an issue with bug reports or feature requests. PRs are more than welcome too.