[nautilus-python] README: Convert to Markdown and modernize



commit 49e58693354c9c1fa5acd22686e84842bfcd8b68
Author: Jan Tojnar <jtojnar gmail com>
Date:   Fri Aug 12 02:19:23 2022 +0200

    README: Convert to Markdown and modernize

 README    | 36 ------------------------------------
 README.md | 31 +++++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+), 36 deletions(-)
---
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4be4c6f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# nautilus-python
+
+This is an extension for Nautilus that allows further extending it with Python scripts with the help of 
Nautilus’s GObject API.
+
+For examples and documentation check the `examples/` subdirectory.
+
+## Requirements
+
+- Nautilus ≥ 3.27.90
+- Python 3.x
+- PyGObject 3
+
+## Running Extensions
+
+Scripts are loaded in the following order:
+
+ 1. `$XDG_DATA_HOME/nautilus-python/extensions` (i.e. `~/.local/share/…`)
+ 2. `nautilus_prefix/share/nautilus-python/extensions` (i.e. `~/Development/…`)
+ 3. `$XDG_DATA_DIRS/nautilus-python/extensions` (i.e. `/usr/share/…`)
+
+Simply copy your Python scripts into one of those directories and restart Nautilus.
+
+## Issues
+
+It is currently not possible to reload a Python script without restarting Nautilus.
+
+Run Nautilus with the `NAUTILUS_PYTHON_DEBUG=misc` environment variable to print out debug information.
+
+## License
+
+nautilus-python is released under the terms of the GNU General Public License, either version 2.0 or, at 
your option, any later version.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]