Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/lainsce/notejot
Browse files Browse the repository at this point in the history
  • Loading branch information
Lains committed Sep 10, 2021
2 parents d81bbfe + e5a2570 commit 5e40c28
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
# ![icon](data/icon.png) Notejot
<img align="left" style="vertical-align: middle" width="120" height="120" src="data/icon.png">

## Stupidly simple notes app
# Notejot

<a href='https://flathub.org/apps/details/io.github.lainsce.Notejot'><img width='240' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
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
<p align="center"><a href='https://flathub.org/apps/details/io.github.lainsce.Notejot'><img width='240' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a></p>

## πŸ’ 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.

Expand All @@ -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/`
12 changes: 6 additions & 6 deletions po/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# 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/<you_username>/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 <language_code>.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 <language code>```
* Then, type ```git add *```
* Finally, ```git commit -m "Translated your app for <Language Name>" && git push```, follow the instructions in the terminal if need be, then type your github username and password.

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`

0 comments on commit 5e40c28

Please sign in to comment.