Commit 381445f3 authored by David Seaward's avatar David Seaward
Browse files

fresh readme (old repo now at wiki)

parents
Purist services notebook
========================
**project** | [wiki] | [tracker] | *snippets*
Project management, software architecture and UX design for Purist
applications and services. See below for an overview. See [wiki]
for a page index.
[project]: https://code.puri.sm/purist/services
[wiki]: https://code.puri.sm/purist/services/wiki
[tracker]: https://code.puri.sm/purist/services/issues
[snippets]: https://code.puri.sm/purist/snippets/src/master/services
## Overview
An easy-to-install private communication suite that users can access
from all their devices, secure from monitoring by the operator or
third-parties, and optionally host themselves. [Read more about our
approach...](./wiki/project_overview)
### Audience
* This notebook is for technical readers interested in
*software engineering* and *design*. See setup and usage instructions
below.
* For programmers interested in *active development*, see
[code.puri.sm/purist](https://code.puri.sm/purist)
* ~~For users wanting to sign-up for services and download applications, see <https://puri.st>~~ (not yet available)
## Setup
To view issues and wiki pages, no setup is required, simply follow the
links.
To add issues and modify wiki pages, you must register and log into
<https://code.puri.sm>
To make contributions to the wiki via Git:
* Download the wiki content with Git
* From the command line, navigate to the base repo folder
* Create a self-referencing symlink with
`ln -s /full/path/to/base/folder`
* Rename the new symlink folder to `wiki`
(This symlink to ourselves is required because Gogs requires that our
relative paths start `./wiki` - see
[Gogs #2080](https://github.com/gogits/gogs/issues/2080))
## Usage
To edit a local copy of the wiki:
* Open `Home.md` in a compatible editor (for example, ReText)
* Click links to the live preview to open linked files
## Submit support issues by email only
The tracker associated with this repo is used as a central location for
high-level public planning, not support issues.
Please email any support issues to <support@puri.sm> rather than adding
an issue to the tracker. Any support issues in the tracker will be
closed.
## Sharing and contributions
Purist services notebook <br />
<https://code.puri.sm/purist/services> <br />
Copyright 2017-2018 Purism SPC and contributors <br />
SPDX-License-Identifier: CC-BY-SA-4.0
Shared under CC-BY-SA-4.0, see [COPYING.BYSA.md](./wiki/COPYING.BYSA.md)
for details. We adhere to the Contributor Covenant 1.4 without
modification, see [CODE_OF_CONDUCT.md](./wiki/CODE_OF_CONDUCT.md) for
details. Contributions under the same terms are welcome.
Contributions and license notices from other sources are listed in
[COPYING.md](./wiki/COPYING.md)
Markdown is supported
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