From 70cee145ec80a1d9a18eb4f86005775735b0d14d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Rusn=C3=A1k?= <88430167+DeRusGAMING@users.noreply.github.com> Date: Thu, 13 Apr 2023 11:18:51 +0200 Subject: [PATCH] Update README.md This pull request optimizes the readme.md file for the BitByBit Core Library. The new version removes unnecessary sections and simplifies the language to make it easier to read and understand. The updated readme.md includes the following changes: - Simplified the section on the separation of the library from the UI, to make it clearer and more concise. - Reorganized the sections to group related information together and make the overall structure more logical. - Simplified the language and removed unnecessary details to make the readme.md easier to read and understand. - Removed redundant links and added descriptions to the remaining ones, to make them more useful for the reader. - Updated the list of dependencies to make it more consistent and easier to read. These changes should make it easier for users to understand what the library does, how it can be used, and where to find additional resources. --- README.md | 79 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 45 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index e8d0744e..97f3658b 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,57 @@ -## Bit By Bit Developers core library +## BitByBit Core Library Picture showing bitbybit.dev platform -This project contains core 3D algorithms of Bit By Bit Developers platform which are open-sourced under MIT license. This library was previously UI dependant and is now separated to ensure protection of our corporate identity and cloud services. +This project contains core 3D algorithms of BitByBit's platform, which are open-sourced under the MIT license. This library is now separated from the UI to ensure protection of our corporate identity and cloud services. -Visit https://bitbybit.dev to use our full cloud platform. +To use our full cloud platform, visit https://bitbybit.dev. -## Github -https://github.com/bitbybit-dev/bitbybit -## NPM -https://www.npmjs.com/package/bitbybit-core +### Resources -## Example Applications -Laptop Holder -https://app-store.bitbybit.dev/laptop-holder -Github Source Code Angular - https://github.com/bitbybit-dev/app-examples/tree/main/angular/laptop-holder -Github Source Code React - https://github.com/bitbybit-dev/app-examples/tree/main/react/laptop-holder - -Cup Configurator -https://app-store.bitbybit.dev/cup -Github Source Code - https://github.com/bitbybit-dev/app-examples/tree/main/react/cup +- **GitHub**: https://github.com/bitbybit-dev/bitbybit +- **NPM**: https://www.npmjs.com/package/bitbybit-core -## Closed Source Example Applications -https://app-store.bitbybit.dev/terrace-furniture +### Example Applications -## Build package -tsc -p tsconfig.bitbybit.json +- **Laptop Holder** + - [Live Demo](https://app-store.bitbybit.dev/laptop-holder) + - [Angular Source Code](https://github.com/bitbybit-dev/app-examples/tree/main/angular/laptop-holder) + - [React Source Code](https://github.com/bitbybit-dev/app-examples/tree/main/react/laptop-holder) + +- **Cup Configurator** + - [Live Demo](https://app-store.bitbybit.dev/cup) + - [React Source Code](https://github.com/bitbybit-dev/app-examples/tree/main/react/cup) -## Media Channels -Discord: https://discord.gg/GSe3VMe -Youtube: https://www.youtube.com/channel/UCWM0VODRsLYOjB2IAaFHBSQ -Instagram: https://www.instagram.com/bitbybit.dev -Twitter: https://twitter.com/bitbybit_dev -LinkedIn: https://lnkd.in/gQjEQA2 -Facebook: https://www.facebook.com/bitbybitdev -Medium: https://bitbybit-dev.medium.com/ +### Closed Source Example Applications -## Principles -Bit By Bit Developers company will keep these core algorithms that you can find in this repository free and opensource for its users. These algorithms are based on other open-source projects, run and are deployed on the browser, thus there is no point of closing them down from public. +- **Terrace Furniture**: https://app-store.bitbybit.dev/terrace-furniture -## About Bit By Bit Developers platform -Bit By Bit Developers web platform allows creators to program geometry through simple visual programming language or choose monaco typescript editor with full intellisense of bitbybit API. This cloud platform can fulfil many practical, educational and artistic needs of its users. Through familiar programming interface used in tools such as Scratch and Blockly.Games we expose powerful 3D algorithms that make it easier to implement various parametric tasks. Our goal is to make it very simple for users to share their ideas and designs. We want to encourage everyone to engage in the future of this tool. +### Build package -## Major Dependencies -BabylonJS, Blockly, OpenCascade, JSCAD, Verbnurbs \ No newline at end of file +To build the package, run: `tsc -p tsconfig.bitbybit.json`. + +### Media Channels + +- **Discord**: https://discord.gg/GSe3VMe +- **Youtube**: https://www.youtube.com/channel/UCWM0VODRsLYOjB2IAaFHBSQ +- **Instagram**: https://www.instagram.com/bitbybit.dev +- **Twitter**: https://twitter.com/bitbybit_dev +- **LinkedIn**: https://lnkd.in/gQjEQA2 +- **Facebook**: https://www.facebook.com/bitbybitdev +- **Medium**: https://bitbybit-dev.medium.com/ + +### Principles + +BitByBit Developers will keep these core algorithms free and open-source for its users. These algorithms are based on other open-source projects, run and are deployed on the browser, thus there is no point of closing them down from the public. + +### About BitByBit Developers platform + +BitByBit Developers' web platform allows creators to program geometry through a simple visual programming language or choose a Monaco TypeScript editor with full intellisense of BitByBit API. This cloud platform can fulfill practical, educational, and artistic needs of its users. Through a familiar programming interface used in tools such as Scratch and Blockly.Games, we expose powerful 3D algorithms that make it easier to implement various parametric tasks. Our goal is to make it very simple for users to share their ideas and designs. We want to encourage everyone to engage in the future of this tool. + +### Major Dependencies + +- BabylonJS +- Blockly +- OpenCascade +- JSCAD +- Verbnurbs