diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7fa3e30f4..7c52a688ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,6 +45,6 @@ Why? However trivial the changes might seem, there might be subtle reasons for t ## Wrap up -Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion on our community [forum](https://discourse.speckle.works). +Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion on our community [forum](https://speckle.community). 🙌❤️💙💚💜🙌 diff --git a/packages/frontend/README.md b/packages/frontend/README.md index 1120669db0..805ae40c99 100644 --- a/packages/frontend/README.md +++ b/packages/frontend/README.md @@ -1,6 +1,6 @@ # The Speckle Frontend App -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white)](https://speckle.community) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) ## Disclaimer @@ -39,7 +39,7 @@ npm run build ## Community -If in trouble, the Speckle Community hangs out on [the forum](https://discourse.speckle.works). Do join and introduce yourself! We're happy to help. +If in trouble, the Speckle Community hangs out on [the forum](https://speckle.community). Do join and introduce yourself! We're happy to help. ## License diff --git a/packages/server/readme.md b/packages/server/readme.md index eede704e3a..8ea63f2f16 100644 --- a/packages/server/readme.md +++ b/packages/server/readme.md @@ -1,6 +1,6 @@ # Speckle Server -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white)](https://speckle.community) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) #### Status @@ -26,7 +26,7 @@ First, ensure you have postgres and redis ready and running: - create a postgres db called `speckle2_dev` - ensure you have an instance of redis running -Finally, in the `packages/server` folder: +Finally, in the `packages/server` folder: - copy the `.env-example` file to `.env`, - open and edit the `.env` file, filling in the required variables, @@ -34,7 +34,6 @@ Finally, in the `packages/server` folder: - finally `npm run dev`, - check `localhost:3000/graphql` out! - ## Developing The server consists of several semi-related components, or modules. These can be found in `/modules`. Module composition: @@ -67,7 +66,7 @@ To run all tests, simply run `npm run test`. To run specific tests, use the `moc ## Community -The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions! +The Speckle Community hangs out on [the forum](https://speckle.community), do join and introduce yourself & feel free to ask us questions! ## License diff --git a/packages/viewer/readme.md b/packages/viewer/readme.md index 09ca894152..2f9e4824ae 100644 --- a/packages/viewer/readme.md +++ b/packages/viewer/readme.md @@ -1,8 +1,9 @@ # The Speckle Viewer -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white)](https://speckle.community) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) ## Disclaimer + We're working to stabilize the 2.0 API, and until then there will be breaking changes. ## Documentation @@ -27,7 +28,8 @@ npm run build ## Community -If in trouble, the Speckle Community hangs out on [the forum](https://discourse.speckle.works). Do join and introduce yourself! We're happy to help. +If in trouble, the Speckle Community hangs out on [the forum](https://speckle.community). Do join and introduce yourself! We're happy to help. ## License + Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@speckle.systems). diff --git a/readme.md b/readme.md index d3075ae7f1..0734aeb7bc 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ # Speckle Web -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white)](https://speckle.community) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) #### Status @@ -26,7 +26,7 @@ The frontend is a static Vue app. ### ➡️ [Viewer](packages/viewer), the Speckle Viewer. -The viewer is a [threejs](https://threejs.org/) extension that allows you to display data from Speckle. +The viewer is a [threejs](https://threejs.org/) extension that allows you to display data from Speckle. ## Documentation @@ -36,7 +36,7 @@ Comprehensive developer and user documentation can be found in our: ## Developing and Debugging -To get started, first clone this repo. Check out the detailed instructions for each module in their respective folder (see links above). +To get started, first clone this repo. Check out the detailed instructions for each module in their respective folder (see links above). ## Bootsrap local Speckle Server @@ -63,7 +63,7 @@ When pushing commits to this repo, please follow the following guidelines: ## Community -The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions! +The Speckle Community hangs out on [the forum](https://speckle.community), do join and introduce yourself & feel free to ask us questions! ## License