From 94fe9b5e17e4a44276883346da1d8977a79c241a Mon Sep 17 00:00:00 2001 From: "Joseph Hale, MS SE" <47901316+thehale@users.noreply.github.com> Date: Thu, 21 Nov 2024 01:05:07 -0800 Subject: [PATCH] docs: Add posterboard to README Give visitors something immediate to look at and begin learning about the project without any extra effort. --- README.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d7eaa88..5bb55e4 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ smartcubes by embedding speakers into the cube's centercaps. [![](https://badgen.net/github/license/thehale/DIY-Smartcube)](https://github.com/thehale/DIY-Smartcube/blob/master/LICENSE) [![](https://badgen.net/badge/icon/Sponsor/pink?icon=github&label)](https://github.com/sponsors/thehale) -[![Joseph Hale's software engineering blog](https://img.shields.io/badge/jhale.dev-black.svg?style=plastic&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNCIgaGVpZ2h0PSI0IiB2aWV3Qm94PSIwIDAgMS4wNTggMS4wNTgiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PGcgY29sb3I9IiMwMDAiIHBhaW50LW9yZGVyPSJmaWxsIG1hcmtlcnMgc3Ryb2tlIj48cGF0aCBkPSJNLjY0My43NTJhLjE1Ni4xNTYgMCAwMC0uMTMuMDU5Qy40NzYuODUuNDcuOTE3LjQ2OS45M2EuMDI1LjAyNSAwIDAwLjAyNi4wMjhoLjA2NmEuMDI1LjAyNSAwIDAwLjAyNC0uMDIuMTIuMTIgMCAwMS4wMi0uMDUyQy42MTguODcuNjMyLjg2OS42NTUuODY5aC4xMjJjMC0uMDAyLjA3Ni4wMDcuMTI5LS4wNUEuMTQzLjE0MyAwIDAwLjkyOC43ODcuMDI1LjAyNSAwIDAwLjkwNi43NTJILjY0M3oiIGZpbGw9IiMwNTAiLz48cGF0aCBkPSJNLjM5My40MWEuMDIuMDIgMCAwMC0uMDIuMDJ2LjI2YzAgLjAxMi4wMDEuMDI5LS4wMTQuMDQ0Qy4zMy43NTkuMjgyLjc1LjI2Ny43MzYuMjU3LjcyOC4yNS43MTMuMjQ0LjY4N0EuMDI1LjAyNSAwIDAwLjIyLjY3SC4xNTNhLjAyNC4wMjQgMCAwMC0uMDI1LjAyNmMuMDA0LjA1Mi4wMjUuMDkuMDUxLjExOWEuMTY3LjE2NyAwIDAwLjExMy4wNTJoLjAzNWEuMTg0LjE4NCAwIDAwLjExNS0uMDVBLjE4Mi4xODIgMCAwMC40OS42OTRWLjQzMUEuMDIuMDIgMCAwMC40Ny40MXpNLjc4Ny4zOWEuMDIuMDIgMCAwMC0uMDIuMDJ2LjI0MmMwIC4wMTEuMDA5LjAyLjAyLjAyaC4wNzdhLjAyLjAyIDAgMDAuMDItLjAyVi40MTFhLjAyLjAyIDAgMDAtLjAyLS4wMnpNLjM5My4yMThhLjAyLjAyIDAgMDAtLjAyLjAydi4wNzdjMCAuMDExLjAwOC4wMi4wMi4wMkguNDdhLjAyLjAyIDAgMDAuMDItLjAyVi4yMzhhLjAyLjAyIDAgMDAtLjAyLS4wMnpNLjU5LjFhLjAyLjAyIDAgMDAtLjAyLjAydi41MzJjMCAuMDExLjAwOS4wMi4wMi4wMmguMDc3YS4wMi4wMiAwIDAwLjAyLS4wMlYuMTJBLjAyLjAyIDAgMDAuNjY3LjF6IiBmaWxsPSIjMDBkNDAwIi8+PC9nPjwvc3ZnPg==)](https://jhale.dev) -[![](https://img.shields.io/badge/Follow-thehale-0A66C2?logo=linkedin)](https://www.linkedin.com/comm/mynetwork/discovery-see-all?usecase=PEOPLE_FOLLOWS&followMember=thehale) +[![Joseph Hale's software engineering blog](https://jhale.dev/badges/website.svg)](https://jhale.dev) +[![](https://jhale.dev/badges/follow.svg)](https://www.linkedin.com/comm/mynetwork/discovery-see-all?usecase=PEOPLE_FOLLOWS&followMember=thehale) --- @@ -15,6 +15,8 @@ smartcubes by embedding speakers into the cube's centercaps. honors thesis in Software Engineering for Barrett, The Honors College at Arizona State University from Spring 2020 through Spring 2022.* +![](./posterboard/posterboard.svg) + ## Abstract Speedsolving, the art of solving twisty puzzles like the Rubik's Cube @@ -46,15 +48,14 @@ This repository has a LOT of information at varying levels of complexity. I reco 2. The [Defense Presentation](./presentation/defense_presentation.pdf) (30 slides + commentary) used to provide a detailed overview of the proposal in my Honors Thesis Defense. 3. The [Thesis Document](./thesis/DIY-Smartcube_Hale_Spring_2022.pdf) (98 pages) containing the full proposal including requirements, designs, specifications, and examples. -## The Legal Stuff +## License +Copyright (c) 2022-2024 Joseph Hale, All Rights Reserved + +Provided under the terms of the [Mozilla Public License, version 2.0](./LICENSE) -``` -`DIY Smartcube` by Joseph Hale is licensed under the terms of the Mozilla -Public License, v 2.0, which are available at https://mozilla.org/MPL/2.0/. +
-You can download the source code for `DIY Smartcube` for free from -https://github.com/thehale/DIY-Smartcube. -``` +What does the MPL-2.0 license allow/require? ### TL;DR @@ -66,11 +67,11 @@ program) under the MPL-2.0. The best way to do this is via a Pull Request back into this project. If you have any other questions, you may also find Mozilla's [official -FAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/) for the MPL-2.0 -license insightful. +FAQ](https://www.mozilla.org/en-US/MPL/2.0/FAQ/) for the MPL-2.0 license +insightful. -If you dislike this license, you can contact me about negotiating a -paid contract with different terms. +If you dislike this license, you can contact me about negotiating a paid +contract with different terms. **Disclaimer:** This TL;DR is just a summary. All legal questions regarding usage of this project must be handled according to the @@ -91,3 +92,5 @@ improvements they make. In contrast, the MPL-2.0 license allows code to be used in any software project, while ensuring that any improvements remain available for everyone. + +
\ No newline at end of file -- 2.51.2