commit b2a74471832fb9aee3eab154678cb2d826fdd36e Author: David Goulet dgoulet@torproject.org Date: Mon Feb 7 09:45:27 2022 -0500
readme: Update and modernize with markdown
Signed-off-by: David Goulet dgoulet@torproject.org --- README | 33 ------------------------------ README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 33 deletions(-)
diff --git a/README b/README deleted file mode 100644 index a1421e5186..0000000000 --- a/README +++ /dev/null @@ -1,33 +0,0 @@ -[%5D(http...) - -Tor protects your privacy on the internet by hiding the connection -between your Internet address and the services you use. We believe Tor -is reasonably secure, but please ensure you read the instructions and -configure it properly. - -To build Tor from source: - ./configure && make && make install - -To build Tor from a just-cloned git repository: - sh autogen.sh && ./configure && make && make install - -Home page: - https://www.torproject.org/ - -Download new versions: - https://www.torproject.org/download/download.html - -Documentation, including links to installation and setup instructions: - https://www.torproject.org/docs/documentation.html - -Making applications work with Tor: - https://gitlab.torproject.org/legacy/trac/-/wikis/doc/TorifyHOWTO - -Frequently Asked Questions: - https://www.torproject.org/docs/faq.html - -Release timeline: - https://gitlab.torproject.org/tpo/core/team/-/wikis/NetworkTeam/CoreTorRelea... - -To get started working on Tor development: - See the doc/HACKING directory. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..67767c5f36 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +Tor protects your privacy on the internet by hiding the connection between +your Internet address and the services you use. We believe Tor is reasonably +secure, but please ensure you read the instructions and configure it properly. + +## Build + +To build Tor from source: + +``` +./configure +make +make install +``` + +To build Tor from a just-cloned git repository: + +``` +./autogen.sh +./configure +make +make install +``` + +## Releases + +The tarballs, checksums and signatures can be found: https://dist.torproject.org + +- Checksum: `<tarball-name>.sha256sum` +- Signatures: `<tarball-name>.sha256sum.asc` + +### Schedule + +You can find our release schedule here: + +- https://gitlab.torproject.org/tpo/core/team/-/wikis/NetworkTeam/CoreTorRelea... + +### Keys that CAN sign a release + +The following keys are the maintainers of this repository. One or many of +these keys can sign the releases, do NOT expect them all: + +- Alexander Færøy: + [514102454D0A87DB0767A1EBBE6A0531C18A9179](https://keys.openpgp.org/vks/v1/by-fingerprint/1C1BC007A9F607AA8152C040BEA7B...) +- David Goulet: + [B74417EDDF22AC9F9E90F49142E86A2A11F48D36](https://keys.openpgp.org/vks/v1/by-fingerprint/B74417EDDF22AC9F9E90F49142E86...) +- Nick Mathewson: + [2133BC600AB133E1D826D173FE43009C4607B1FB](https://keys.openpgp.org/vks/v1/by-fingerprint/2133BC600AB133E1D826D173FE430...) + +## Development + +See our hacking documentation in [doc/HACKING/](./doc/HACKING). + +## Resources + +Home page: + +- https://www.torproject.org/ + +Download new versions: + +- https://www.torproject.org/download/download.html + +Documentation, including links to installation and setup instructions: + +- https://www.torproject.org/docs/documentation.html + +Frequently Asked Questions: + +- https://www.torproject.org/docs/faq.html +