ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-20 21:43:09 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

readme fixes

Browse Source
This commit is contained in:
jbaeth 2020-12-07 17:06:28 +03:00
parent d531cc9d6c
commit 82aee95ef6
3 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CREDITS
View File

@ -203,3 +203,7 @@ N: meejah
E: meejah@meejah.ca E: meejah@meejah.ca
P: 0xC2602803128069A7, 9D5A 2BD5 688E CB88 9DEB CD3F C260 2803 1280 69A7 P: 0xC2602803128069A7, 9D5A 2BD5 688E CB88 9DEB CD3F C260 2803 1280 69A7
D: various bug-fixes and features D: various bug-fixes and features
N: Viktoriia Savchuk
W: https://twitter.com/viktoriiasvchk
D: Developer community focused improvements on the README file.

17
README.rst
View File

@ -1,4 +1,6 @@
**Free and Open decentralized data store** ======================================
Free and Open decentralized data store
======================================
|image0| |image0|
@ -41,19 +43,18 @@ The client creates pieces (“shares”) that have a configurable amount of redu
Tahoe-LAFS was first designed in 2007, following the "principle of least authority", a security best practice requiring system components to only have the privilege necessary to complete their intended function and not more. Tahoe-LAFS was first designed in 2007, following the "principle of least authority", a security best practice requiring system components to only have the privilege necessary to complete their intended function and not more.
Please read more about Tahoe-LAFS architecture `here <https://tahoe-lafs.readthedocs.io/en/tahoe-lafs-1.12.1/architecture.html?highlight=usage>`__. Please read more about Tahoe-LAFS architecture `here <docs/architecture.rst>`__.
✅ Installation ✅ Installation
--------------- ---------------
For more detailed instructions, read `docs/INSTALL.rst <https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/INSTALL.rst>`__ . For more detailed instructions, read `docs/INSTALL.rst <docs/INSTALL.rst>`__ .
- Building Tahoe-LAFS on Windows: https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/windows.rst - `Building Tahoe-LAFS on Windows <docs/windows.rst>`__
- | OS-X Packaging: - `OS-X Packaging <docs/OS-X.rst>`__
| https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/OS-X.rst
Once tahoe --version works, see `docs/running.rst <https://github.com/tahoe-lafs/tahoe-lafs/blob/master/docs/running.rst>`__ to learn how to set up your first Tahoe-LAFS node. Once tahoe --version works, see `docs/running.rst <docs/running.rst>`__ to learn how to set up your first Tahoe-LAFS node.
🤗 Contributing 🤗 Contributing
--------------- ---------------
@ -110,7 +111,7 @@ See `TGPPL.PDF <https://tahoe-lafs.org/~zooko/tgppl.pdf>`__ for why the TGPPL ex
.. |image0| image:: docs/_static/media/image2.png .. |image0| image:: docs/_static/media/image2.png
:width: 3in :width: 3in
:height: 0.91667in :height: 0.91667in
.. |image2| image:: docs/_static//media/image1.png .. |image2| image:: docs/_static/media/image1.png
:width: 6.9252in :width: 6.9252in
:height: 2.73611in :height: 2.73611in
.. |readthedocs| image:: http://readthedocs.org/projects/tahoe-lafs/badge/?version=latest .. |readthedocs| image:: http://readthedocs.org/projects/tahoe-lafs/badge/?version=latest

2
newsfragments/3545.other
View File

@ -1 +1 @@
new README based on Victoriia's changes after integrating the team's feedback. new README based on Viktoriia's changes after integrating the team's feedback. README document now is more focused on the developer's community and it provide more information about Tahoe-LAFS, why it's important and how someone can use it or start contributing to it.