Update documentation, test script and readme (#61)

mamolinux · Oct 24, 2024 · d69cb8e · d69cb8e
1 parent 41f74bb
commit d69cb8e
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -199,18 +199,20 @@ cd battery-monitor-master
 		meson compile -C builddir --verbose
 		meson install -C builddir
 		```
-		It will install all files under `/home/<yourusername>/.local`.
+		It will install all files under `/home/<yourusername>/.local`. To **remove** the locally (`/home/<yourusername>/.local`) installed files, run:
+		```
+		ninja uninstall -C builddir
+		```
 	2. To manually install for all users:
 		```
 		rm -rf builddir
 		meson setup builddir
 		meson compile -C builddir --verbose
 		sudo meson install -C builddir
 		```
-		This step requires **Administrative Privilege**. So, be careful before using this.
-	3. To **remove** the locally (`/home/<yourusername>/.local`) installed files, run:
+		The last step requires **Administrative Privilege**. So, be careful before using this. To **remove** the installed files, run:
 		```
-		ninja uninstall -C builddir
+		sudo ninja uninstall -C builddir
 		```
 
 2. **Option 2:** Build a debian package and install it. To build a debian package on your own:
@@ -246,7 +248,7 @@ If you are interested to contribute and enrich the code, you are most welcome. Y
 **NB:** Using the issue template or PR template is **not** mandatory.
 
 ### For Developers
-If you want to test **Battery Monitor**,
+I am managing these apps all by myself during my free time. There are times when I can't contribute for months. So a little help is always welcome. If you want to test **Battery Monitor**,
 1. Get the source package and unzip it using:
 	```
 	wget https://github.com/mamolinux/battery-monitor/archive/refs/heads/master.zip

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Battery Monitor's documentation!
+Welcome to Battery Monitor documentation!
 ===========================================
 
 .. toctree::

diff --git a/po/POTFILES b/po/POTFILES
@@ -1,3 +1,5 @@
+# List of source files containing translatable strings.
+# Please keep this file sorted alphabetically.
 data/org.mamolinux.battery-monitor.gschema.xml.in
 data/battery-monitor-autostart.desktop.in
 data/battery-monitor.desktop.in

diff --git a/test/test b/test/test
@@ -2,6 +2,6 @@
 rm -rf builddir
 meson setup -Dprefix=$HOME/.local builddir
 meson compile -C builddir --verbose
-meson install -C builddir
+meson install -C builddir # --dry-run
 battery-monitor -V
 ninja uninstall -C builddir