From fa134729ecc17b05e78597c5e8d791d2ee7aff7b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20St=C3=BCrmer?= Date: Fri, 3 Nov 2023 20:05:45 +0100 Subject: [PATCH] remove discord from documentations --- CONTRIBUTING.md | 26 ++++------------------ README.md | 57 ++++++++++++------------------------------------- 2 files changed, 18 insertions(+), 65 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7d98688..b155351 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,12 +20,12 @@ A community like this should be **open**, **considerate** and **respectful**. Behaviours that reinforce these values contribute to a positive environment, and include: - * **Being open**. Members of the community are open to collaboration, whether it's on PEPs, patches, problems, or otherwise. + * **Being open**. Members of the community are open to collaboration. * **Focusing on what is best for the community**. We're respectful of the processes set forth in the community, and we work within them. - * **Acknowledging time and effort**. We're respectful of the volunteer efforts that permeate the Python community. We're thoughtful when addressing the efforts of others, keeping in mind that often times the labor was completed simply for the good of the community. + * **Acknowledging time and effort**. We're respectful and thoughtful when addressing the efforts of others, keeping in mind that often times the labor was completed simply for the good of the community. * **Being respectful of differing viewpoints and experiences**. We're receptive to constructive comments and criticism, as the experiences and skill sets of other members contribute to the whole of our efforts. * **Showing empathy towards other community members**. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views. - * **Being considerate**. Members of the community are considerate of their peers -- other Python users. + * **Being considerate**. Members of the community are considerate of their peers. * **Being respectful**. We're respectful of others, their positions, their skills, their commitments, and their efforts. * **Gracefully accepting constructive criticism**. When we disagree, we are courteous in raising our issues. * **Using welcoming and inclusive language**. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate and everyone can make a difference. @@ -68,7 +68,7 @@ If your suggestion can not be found already, see if it is already covered by our ## ๐Ÿ“Ÿ Communication -To get in touch with the community join our [Discord](https://img.shields.io/discord/793235453871390720) or write use on Mastodon: [@photos@mastodon.cloud](https://mastodon.cloud/@photos). +To get in touch with the community or write use on Mastodon: [@photos@mastodon.cloud](https://mastodon.cloud/@photos). @@ -82,21 +82,3 @@ Underneath it is using these frameworks: * [tower](https://github.com/tower-rs/tower) - for networking * [axum](https://github.com/tokio-rs/axum) - as web framework * [abi_stable](https://github.com/rodrimati1992/abi_stable_crates) - FFI for dynamic library loading - - - -## ๐Ÿ’ป Build & Run - -To build and run the core - -```shell -$ cargo run -``` - -### ๐Ÿ”ฌ Verifications - -To run tests - -```shell -$ cargo test -``` diff --git a/README.md b/README.md index d90780d..6a885cd 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ [![License](https://img.shields.io/github/license/photos-network/core?style=for-the-badge)](./LICENSE.md) [![GitHub contributors](https://img.shields.io/github/contributors/photos-network/core?color=success&style=for-the-badge)](https://github.com/photos-network/core/graphs/contributors) -[![Discord](https://img.shields.io/discord/793235453871390720?style=for-the-badge)](https://discord.gg/dGFDpmWp46) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/photos-network/core/check.yaml?style=for-the-badge) @@ -30,70 +29,42 @@ It is responsible for main tasks e.g.: -## ๐Ÿงฉ Contribution - -This is a free and open project and lives from contributions of the community. - -See our [Contribution Guide](CONTRIBUTING.md) - - - ## ๐Ÿงช Development The core is written in ๐Ÿฆ€ [Rust](https://rust-lang.org/) and highly customizably by using a Plugin-system. -#### ๐Ÿ“„ Documentation +#### ๐Ÿ”ฌ Testing -With the nightly version of `cargo doc` an additional index-page will be created. +To run tests for all crates in this workspace, run: ```shell -$ RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo +nightly doc --all --no-deps --document-private-items --all-features +$ cargo test --workspace --all-targets ``` - - -#### ๐Ÿ”ฌ Testing - -An continuous check on all files is done in the background and will trigger `cargo test` on each file change. +Run continuous checks on a specific crate during development. ```shell -$ cargo watch --exec test +$ cargo watch --exec 'test -p media' ``` -To run tests for all crates in this workspace, run: -```shell -$ cargo test --workspace --all-targets -``` -### Visual Studio Code -The fastest start into development can be archived by using [Visual Studio Code](https://code.visualstudio.com/) and [Docker](https://www.docker.com/get-started). +## ๐Ÿ“œ Roadmap (MvP) -1. Install [Docker](https://www.docker.com/get-started) -2. Install [Visual Studio Code](https://code.visualstudio.com/) -3. Install [Visual Studio Code Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) -4. Clone and Open this repository in Visual Studio Code -5. Click the "Reopen in Container" Dialog -6. Launch **Photos.network** from the `RUN` window. + - Create a new media item + - Upload one or multiple images + - Download a list of owned media items + - Download the original file for a specific media item + - Authenticate via openID -![VS Code with devcontainers](vscode.gif) +## ๐Ÿงฉ Contribution -## ๐Ÿ“œ Roadmap (MvP) +This is a free and open project and lives from contributions of the community. - - Authenticate via openID - - Create a new media item - - Upload one or multiple photos - - Download a list of owned media items - - Download the original photo from a specific media item - - *Metadata (size, resolution) - - *EXIF (orientation, image taken timestamp, last modified, camera) - - *RAW (image support for RAW-images) - - *Resize (create low-resolutions / thumbnails) - - *Deep learning (image recognition, Reinforcement learning) - - *Plugin System (extract features into plugins) +See our [Contribution Guide](CONTRIBUTING.md)