From e5a25708ec684e829ce669937533e4373d577338 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=93scar=20Fern=C3=A1ndez=20D=C3=ADaz?= Date: Thu, 9 Sep 2021 23:27:40 +0200 Subject: [PATCH] Update READMEs (#289) --- README.md | 20 ++++++++++++-------- po/README.md | 12 ++++++------ 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6c625620..327b8fff 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,25 @@ -# ![icon](data/icon.png) Notejot + -## Stupidly simple notes app +# Notejot -Download on Flathub +Stupidly simple notes app + +### [![Please do not theme this app](https://stopthemingmy.app/badge.svg)](https://stopthemingmy.app) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) ![Screenshot](data/shot.png) -## Donations +

Download on Flathub

+ +## 💝 Donations Would you like to support the development of this app to new heights? Then: [Be my backer on Patreon](https://www.patreon.com/lainsce) -## Dependencies +## 🛠️ Dependencies Please make sure you have these dependencies first before building. @@ -28,14 +32,14 @@ meson vala ``` -## Building +## 🏗️ Building Simply clone this repo, then: ```bash -meson build --prefix=/usr && cd build +meson _build --prefix=/usr && cd _build sudo ninja install ``` -## Notes Storage +## 🗂️ Notes Storage Notes are stored in `~/.var/app/io.github.lainsce.Notejot/` diff --git a/po/README.md b/po/README.md index b9cee863..0c656f72 100644 --- a/po/README.md +++ b/po/README.md @@ -1,19 +1,19 @@ -# How to Translate Notejot +# 🌐 How to Translate Notejot -## First Things First +## ✏️ First Things First * Fork the repository here on github with the Fork button at the top-right * Clone this repository by opening the terminal in a folder of your choice and typing `git clone https://github.com//notejot` * (Optional) Check [Regenerate translations files](https://github.com/lainsce/notejot/tree/master/po#regenerate-translations-files) section if files haven't been recently updated. -## Basics +## 📃 Basics * You'll need to know your language's code (ex. en = English). * Add that code to the LINGUAS file, in a new line, after the last line. * Translate the .pot file using the PO editor of your choice (I recommend POEdit). * Save it as .po in this folder. -## Not so Basics +## 📝 Not so Basics * Next, in the folder you've cloned this repo in, open a terminal and type: ```git checkout -b "Translation ``` * Then, type ```git add *``` @@ -21,9 +21,9 @@ And that's it! You've successfully translated Notejot for your language! -## Regenerate translations files +## 🔁 Regenerate translations files * Initialize the project build by typing `meson _build` (make sure you have [dependencies](https://github.com/lainsce/notejot#dependencies) installed!). * Compile .pot files, type `meson compile -C _build io.github.lainsce.Notejot-pot` and `meson compile -C _build extra-pot` * (Optional) Compile .po files instead replacing `-pot` with `-update-po` in the previous commands. -Note: install `apppstream` package in order to generate release strings in `extra.pot` +Note: install `appstream` package in order to generate release strings in `extra.pot`