Commit 8b05242e authored by yPhil's avatar yPhil
Browse files

Doc update

- Redefined heading hierarchy
parent d96d6f0b
Pipeline #495298 passed with stage
in 34 seconds
......@@ -85,4 +85,4 @@ Extract and copy the relevant files:
For any question, please [use the repo](https://framagit.org/yphil/petrolette/-/issues/new?issue%5Bmilestone_id%5D=) itself.
Thank you **very much** for any love you give to this project.
Thank you **very much** for [any love you give](https://liberapay.com/yPhil/) to this project.
......@@ -40,10 +40,13 @@ Pétrolette is fully self-contained, makes **no external call** whatsoever, and
- Bookmarklet to **add the feed of any website to Pétrolette** on the fly
- Compatible with [FLOSS browsers](https://www.gnu.org/software/librejs/) (links to all uncompressed executable files, licenses available directly and in standard format)
## What's new?
### What's new?
Read [the changelog](https://framagit.org/yphil/petrolette/-/blob/master/CHANGELOG.md).
## Usage
Pétrolette can be use both locally on an http, or a https server.
### Install
......@@ -57,20 +60,20 @@ npm start
`xdg-open http://localhost:8000` or `xdg-open https://localhost:8001`
#### Update
### Update
```sh
cd petrolette
git pull
npm update
```
#### Test
### Test
```javascript
npm test
```
### Contributing
## Contributing
- Read the [development guidelines](https://framagit.org/yphil/petrolette/-/blob/master/DEV.md)
- Pétrolette is [Free, Libre, and Open-Source Software](https://framagit.org/yphil/petrolette/-/blob/master/LICENSE). However the development requires [a lot of time](https://www.youtube.com/watch?v=JlbMEx9H6FE) and [a lot of work](https://framagit.org/yphil/petrolette/-/commits/master). In order to keep developing it with new features I need your help ; Please consider to [support the Pétrolette project](https://liberapay.com/yPhil/donate) by sending a donation. Even the smallest amount will help a lot.
......
This diff is collapsed.
......@@ -106,6 +106,8 @@ PTL.i18n.translations = {
"The news page that doesn't know you" : { fr: "La page d'actu qui ne sait rien de toi", ja: "あなたを知らないニュースページ", es: "La página de noticias que no te conoce" },
"There are %1 new items in this feed" : { fr: "Il y a %1 nouveaux articles dans ce flux", ja: "このフィードには%1つの新しいアイテムがあります", es: "Hay %1 artículos nuevos en este feed." },
"Name the feed of this website, if it is not informative enough ; leave blank to get the default feed title." : { fr: "Renommez le flux de ce site Web, s'il n'est pas assez informatif ; laisser vide pour obtenir le titre du flux par défaut." , ja: "それが十分に報知されていない場合、このウェブサイトのフィードに名前を付けます。 デフォルトフィードのタイトルを取得するには、空白のままにします", es: "Nombra la feed de este sitio web, si no es lo suficientemente informativo; Deje en blanco para obtener el título de feed predeterminado." },
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment