From 90c94f17e38a67188e56f34fc97addc06ffacfbd Mon Sep 17 00:00:00 2001 From: polistern Date: Tue, 16 Nov 2021 18:31:06 +0000 Subject: [PATCH] Update pages. --- docs/about/contributing.md | 31 +++++++++++++++++++++++++++++++ docs/about/donations.md | 6 ++++++ docs/about/thanks.md | 4 ++-- docs/index.md | 6 +++--- mkdocs.yml | 1 + 5 files changed, 43 insertions(+), 5 deletions(-) create mode 100644 docs/about/donations.md diff --git a/docs/about/contributing.md b/docs/about/contributing.md index e69de29..48fa95d 100644 --- a/docs/about/contributing.md +++ b/docs/about/contributing.md @@ -0,0 +1,31 @@ +# How to contribute + +I'm really glad you're reading this. + +Come find me in [#dev] channel on ilita IRC network in to I2P. + +## Submitting changes + +Please send a [GitHub Pull Request to pboted](https://github.com/polistern/pboted/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). +Please follow conventions (below) and make sure all of your commits are atomic (one feature per commit). + +Always write a clear log message for your commits. +One-line messages are fine for small changes, but bigger changes should look like this: + +``` +$ git commit -m "A brief summary of the commit +> +> A paragraph describing what changed and its impact." +``` + +## Coding conventions + +After a short discussion, one of the [coding styles](https://github.com/motine/cppstylelineup) will be determined, which better meets our requirements. + +But for now: + + * We indent using **two spaces** + * We put spaces after list items and method parameters (`[1, 2, 3]`, not `[1,2,3]`), around operators (`x += 1`, not `x+=1`). + +Sincerely yours, +polistern diff --git a/docs/about/donations.md b/docs/about/donations.md new file mode 100644 index 0000000..66b4f2c --- /dev/null +++ b/docs/about/donations.md @@ -0,0 +1,6 @@ +# Donations + +- **BTC**: `bc1qans7ukm5t62mjcuhl3rpzxml05etyljhjt7w76` +- **DASH**: `XfeBg9i7MwbW2X1y1HpgHZ4sB7jqxhSfta` +- **GST**: `GatPEoV4uK2z1mgbph577Tv1WavrL5vmSE` +- **XMR**: `85P3aEXrYMn1YxnQaZSBWy6Ur6j9PVRxmCd3Ey1UanKAdKnhd2iYNdrEhNJ2JeUdcC8otSHogRTnydn4aMh8DwbSMs4N13Z` diff --git a/docs/about/thanks.md b/docs/about/thanks.md index 10f5984..86e2efd 100644 --- a/docs/about/thanks.md +++ b/docs/about/thanks.md @@ -1,4 +1,4 @@ # Special thanks -* [orignal](https://github.com/orignal) - as mentor -* [R4SAS](https://github.com/r4sas) - hurrying to the rescue +* [orignal](https://github.com/orignal) - for mentoring +* [R4SAS](https://github.com/r4sas) - for the help at the start diff --git a/docs/index.md b/docs/index.md index 244375b..2ae8cdd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,10 +3,10 @@ pboted (Plus Bote Daemon) - is a standalone C++ implementation of I2P-Bote protocol. I2P-Bote is a server-less encrypted KademliaDHT-based email protocol. -You can find more details it Bote section. +You can find more details it [Bote](devs/bote/v5/version5.md) section. -Interaction with the I2P network occurs through the SAMv3 interface. -Tested with i2pd and Java I2P. +Interaction with the I2P network occurs through the [SAMv3](https://geti2p.net/ru/docs/api/samv3) interface. +Tested with [i2pd](https://github.com/PurpleI2P/i2pd) and [Java I2P](https://github.com/i2p/i2p.i2p). ## Features diff --git a/mkdocs.yml b/mkdocs.yml index 058f569..7b2fe0f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,6 +45,7 @@ nav: - License: about/license.md - Special thanks: about/thanks.md - Contributing: about/contributing.md + - Donations: about/donations.md copyright: CC-BY-SA 4.0, Maintained by polistern