From 25cbdd74396e7f43e2183c45b3492d91dd73a88d Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Tue, 19 Jul 2022 10:59:49 -0400 Subject: [PATCH 01/22] Update README.md Started restructuring the README file --- README.md | 45 +++++++++++++++------------------------------ 1 file changed, 15 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 439c057ab..8f7272ca8 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,30 @@ # Legup -### A Project by Dr. van Heuveln -Logic Engine for Grid-Using Puzzles - a better way to learn formal logic +Legup (short for Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by Dr. Bram van Heuveln, whose goal is to provide a better interface for students to learn the basic principles of logical reasoning. -## Goal -The main goal of the Legup is to provide a better interface for students to learn basic principles of logical reasoning. +## Table of Contents +- [Background](#background) +- [Use Cases](#use-cases) +- [Documentation](#documentation) +- [Contributing](#contributing) +- [License](#license) -Dr. van Heuveln has taught logic courses on a frequent basis for the past 15 years, and noted that a good number of students struggle with the systems of modern formal logic that were developed in the late 1800's and early 1900's, and that have been universally used in logic courses since. These traditional systems use abstract linear symbol strings such as `(P & Q) -> (R v S)`, and deploy even more abstract rules such as & Elim to infer new symbol strings from old ones, thus engaging the user in logical reasoning. +## Background +Dr. Bram van Heuveln has taught logic courses on a frequent basis for the past 15 years, and noted that a good number of students struggle with the systems of modern formal logic that were developed in the late 1800's and early 1900's, and that have been universally used in logic courses since. These traditional systems use abstract linear symbol strings such as `(P & Q) -> (R v S)`, and deploy even more abstract rules such as & Elim to infer new symbol strings from old ones, thus engaging the user in logical reasoning. This project brings about the idea that there are more pedagogically effective ways for students to learn the basic and important principles of logical reasoning. Legup uses a more visual representation in a more concrete and engaging environment. These and other features of the Legup interface are suspected to have several advantages over more traditional interfaces in terms of learning logic. ## Use Cases - The Legup interface allows the user to solve different types of grid-based logical puzzles. Probably the best known example of such a puzzle is the popular Sudoku puzzle, but there are many other types of puzzles that are based on the principle of filling in cells of a square or rectangular grid with different kinds of objects. In all cases, the user is provided certain clues that will force a unique configuration of objects in the grid. These types of puzzles are often advertised as 'logic puzzles', and are claimed to train one's logical mind as, using deduction, users should be able to infer which object goes where. So, how does the Legup interface differ from online platforms for grid-based games? The most important difference is that the Legup interface requires the user to explicitly indicate their logical reasoning. Thus, solving the puzzle due to some lucky guesses is no longer an option! The interface will congratulate the user less on the fact that the user was able to solve the puzzle, but more on how the user solved the puzzle. This is essential to logic: logic is not about the truth or the correct or best answer, but about deductive implication and valid inference: what follows from what, and why? Legup also provides a single interface that is capable of supporting many different types of puzzles. Since most of the interface remains the same, however, users wil start to recognize certain similarities between the different puzzles. In particular, since they have to explicitly state their reasoning, users should start to see strong similarities in their logical reasoning patterns from puzzle to puzzle, is the very basis of the abstract logical reasoning principles taught in traditional logic courses. However, rather than being 'thrown in the water' with abstract principles based on obscure symbols, users instead are dealing with a concrete, fun, and engaging logic puzzle. As such, LEGUP aims to give its users a 'leg up' when it comes to the understanding of logic. -## Gradle - -This project uses Gradle for dependency management. - -## XML Board Specifications - -An example for the Battleship puzzle demonstrates the proper format for XML files to be read in. Puzzles have particular x and y values associated with a location of each puzzleElement. The board size dictates the square size of the board. Legup supports many puzzles, such as Light Up, Nurikabe, Short Truth Table, etc., with others such as Battleship, Skyscrapers, and Tree Tent actively in development. - -``` - - - - - - - - - - - - - -``` -Element values are dependent on the type of `edu.rpi.legup.puzzle`. +## Documentation + +## Contributing + +## License +Legup is licensed under the GPL-3.0 license, which can be viewed [here](LICENSE). From bfa9e5be7cb7aca22cb0e9e38e0302900ea5ce61 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Tue, 19 Jul 2022 11:00:29 -0400 Subject: [PATCH 02/22] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f7272ca8..a7825a214 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Legup (short for Logic Engine for Grid-Using Puzzles), is a better way to learn - [License](#license) ## Background -Dr. Bram van Heuveln has taught logic courses on a frequent basis for the past 15 years, and noted that a good number of students struggle with the systems of modern formal logic that were developed in the late 1800's and early 1900's, and that have been universally used in logic courses since. These traditional systems use abstract linear symbol strings such as `(P & Q) -> (R v S)`, and deploy even more abstract rules such as & Elim to infer new symbol strings from old ones, thus engaging the user in logical reasoning. +Dr. van Heuveln has taught logic courses on a frequent basis for the past 15 years, and noted that a good number of students struggle with the systems of modern formal logic that were developed in the late 1800's and early 1900's, and that have been universally used in logic courses since. These traditional systems use abstract linear symbol strings such as `(P & Q) -> (R v S)`, and deploy even more abstract rules such as & Elim to infer new symbol strings from old ones, thus engaging the user in logical reasoning. This project brings about the idea that there are more pedagogically effective ways for students to learn the basic and important principles of logical reasoning. From 7603cc4e40be84efa9ef8923cac0f348491a3fc4 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Tue, 19 Jul 2022 11:09:08 -0400 Subject: [PATCH 03/22] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a7825a214..bfb0bf185 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Legup -Legup (short for Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by Dr. Bram van Heuveln, whose goal is to provide a better interface for students to learn the basic principles of logical reasoning. +Legup (Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by Dr. Bram van Heuveln, whose goal is to provide a better interface for students to learn the basic principles of logical reasoning. + +> Note: [A web version of Legup](https://github.com/Bram-Hub/LegupWeb) based on this app version of Legup is actively being developed. However, it is very much in the early stages of development and will not be ready for general use for quite a while. Contributions to both versions of Legup are greatly appreciated. If you are interested in using Legup for educational purposes, please use this app version. ## Table of Contents - [Background](#background) From d20833d8f97d69087a2362625b575f1d044dbfd6 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Tue, 19 Jul 2022 11:13:07 -0400 Subject: [PATCH 04/22] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bfb0bf185..e0a8aa4ab 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Legup Legup (Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by Dr. Bram van Heuveln, whose goal is to provide a better interface for students to learn the basic principles of logical reasoning. -> Note: [A web version of Legup](https://github.com/Bram-Hub/LegupWeb) based on this app version of Legup is actively being developed. However, it is very much in the early stages of development and will not be ready for general use for quite a while. Contributions to both versions of Legup are greatly appreciated. If you are interested in using Legup for educational purposes, please use this app version. +> Note: A web version of Legup ([Bram-Hub/LegupWeb](https://github.com/Bram-Hub/LegupWeb)) based on this app version of Legup is actively being developed. However, it is very much in the early stages of development and will not be ready for general use for quite a while. Contributions to both versions of Legup are greatly appreciated. If you are interested in using Legup for educational purposes, please use this app version. ## Table of Contents - [Background](#background) From fe9719e010b08488611ae0dd0d6bddada2eda5cc Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Wed, 20 Jul 2022 16:55:30 -0400 Subject: [PATCH 05/22] Rename contributing.md to CONTRIBUTING.md --- contributing.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename contributing.md => CONTRIBUTING.md (100%) diff --git a/contributing.md b/CONTRIBUTING.md similarity index 100% rename from contributing.md rename to CONTRIBUTING.md From 5fffbf8e32d6bb026c4d0818dd9118cd26e7d0c0 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Wed, 20 Jul 2022 16:59:22 -0400 Subject: [PATCH 06/22] Update CONTRIBUTING.md --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c84f1c0de..ca8cdc287 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,12 +4,13 @@ Thank you for investing your time and contributing to Legup! In this guide, you ## New Contributor Guide To get an overview of the project, please reference the [README](https://github.com/Bram-Hub/Legup/blob/master/README.md). -### Getting Started -Before you begin coding, please read our [programming principles](https://github.com/Bram-Hub/Legup/wiki/Programming-Principles). This will cover our standards for commenting, documenting and reporting issues, and creating and merging branches. +### Programming Standards +Before you begin coding, please familiarize yourself with our [programming standards](https://github.com/Bram-Hub/Legup/wiki/Programming-Principles). This will cover our standards for commenting, documenting and reporting issues, and creating and merging branches. ***If there is any one point that should be emphasized from the programming principles, it's that for the most part, all developers should branch off of and merge into `dev`***. `dev` will be the only branch that merges into `master` and will be done under the approval of Dr. van Heuveln. +## Developer Setup Guide Please refer to the [developer setup guide](https://github.com/Bram-Hub/Legup/wiki/Programming-Setup-Guide) to get set up with the Legup repository. Please note that the developer setup guide is a *guide*. We recommend you use IntelliJ and GitHub Desktop, but feel free to use other IDEs and/or the command line if you feel more comfortable with that. -## References -This guide is loosely adapted from the [GitHub docs contributing guide](https://github.com/github/docs/blob/main/CONTRIBUTING.md). +## Helpful Suggestions +Please reference [this page](https://github.com/Bram-Hub/Legup/wiki/Some-Pointers-for-Getting-Started) for some helpful suggestions on where to get started. From c68e6ff9921d7d298440420b84d2b810d6e84f69 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Wed, 20 Jul 2022 16:59:56 -0400 Subject: [PATCH 07/22] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca8cdc287..12105c9d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Thank you for investing your time and contributing to Legup! In this guide, you will get an overview of the general principles you should follow when contributing to Legup. ## New Contributor Guide -To get an overview of the project, please reference the [README](https://github.com/Bram-Hub/Legup/blob/master/README.md). +To get an overview of the project, please reference the [README](README.md). ### Programming Standards Before you begin coding, please familiarize yourself with our [programming standards](https://github.com/Bram-Hub/Legup/wiki/Programming-Principles). This will cover our standards for commenting, documenting and reporting issues, and creating and merging branches. From 677a1ccea1383759fe727d7c16581c028986467d Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Wed, 20 Jul 2022 17:01:07 -0400 Subject: [PATCH 08/22] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12105c9d8..ac85989ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,10 +7,8 @@ To get an overview of the project, please reference the [README](README.md). ### Programming Standards Before you begin coding, please familiarize yourself with our [programming standards](https://github.com/Bram-Hub/Legup/wiki/Programming-Principles). This will cover our standards for commenting, documenting and reporting issues, and creating and merging branches. -***If there is any one point that should be emphasized from the programming principles, it's that for the most part, all developers should branch off of and merge into `dev`***. `dev` will be the only branch that merges into `master` and will be done under the approval of Dr. van Heuveln. - ## Developer Setup Guide -Please refer to the [developer setup guide](https://github.com/Bram-Hub/Legup/wiki/Programming-Setup-Guide) to get set up with the Legup repository. Please note that the developer setup guide is a *guide*. We recommend you use IntelliJ and GitHub Desktop, but feel free to use other IDEs and/or the command line if you feel more comfortable with that. +Please refer to the [developer setup guide](https://github.com/Bram-Hub/Legup/wiki/Programming-Setup-Guide) to get set up with the Legup repository. The setup guide will set you up to use IntelliJ and GitHub Desktop (which is what we prefer and recommend), but feel free to use other IDEs and/or the command line if you feel more comfortable with that. ## Helpful Suggestions Please reference [this page](https://github.com/Bram-Hub/Legup/wiki/Some-Pointers-for-Getting-Started) for some helpful suggestions on where to get started. From cc595d7c29b56d5af260d1543f14d2ff6422c9d2 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Wed, 20 Jul 2022 17:05:22 -0400 Subject: [PATCH 09/22] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e0a8aa4ab..268917e75 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,11 @@ Legup also provides a single interface that is capable of supporting many differ ## Documentation ## Contributing +All contributions to Legup will be greatly appreciated. Currently, we need the most help in the following areas: +- Documentation +- Test suites + +Please read our [contribution guidelines](CONTRIBUTING.md) for more detailed guidelines on how to contribute to Legup. ## License Legup is licensed under the GPL-3.0 license, which can be viewed [here](LICENSE). From bb1e180e0ed82a36efc629fcd9a1c8a7444fc084 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Thu, 21 Jul 2022 13:06:01 -0400 Subject: [PATCH 10/22] Update CONTRIBUTING.md --- CONTRIBUTING.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ac85989ca..1944ca58f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,12 @@ -# Welcome to the Legup Contributing Guide -Thank you for investing your time and contributing to Legup! In this guide, you will get an overview of the general principles you should follow when contributing to Legup. - -## New Contributor Guide -To get an overview of the project, please reference the [README](README.md). - -### Programming Standards -Before you begin coding, please familiarize yourself with our [programming standards](https://github.com/Bram-Hub/Legup/wiki/Programming-Principles). This will cover our standards for commenting, documenting and reporting issues, and creating and merging branches. - -## Developer Setup Guide -Please refer to the [developer setup guide](https://github.com/Bram-Hub/Legup/wiki/Programming-Setup-Guide) to get set up with the Legup repository. The setup guide will set you up to use IntelliJ and GitHub Desktop (which is what we prefer and recommend), but feel free to use other IDEs and/or the command line if you feel more comfortable with that. - -## Helpful Suggestions -Please reference [this page](https://github.com/Bram-Hub/Legup/wiki/Some-Pointers-for-Getting-Started) for some helpful suggestions on where to get started. +# Contributing +Thank you for investing your time and contributing to Legup! In this guide, you will get an overview of the general principles you should follow when contributing to Legup. Legup is open source software, so anyone and everyone is welcome to contribute to this project. Some of the types of contributions accepted include, but aren't limited to, the following: +- Developing and maintaining the code +- Documentation +- Testing + +## Guides +Please refer to the following guides when contributing: +- Legup Development Process + - [Developer Setup Guide for First-Time Contributors](https://github.com/Bram-Hub/Legup/wiki/Programming-Setup-Guide) + - [Programming Standards](https://github.com/Bram-Hub/Legup/wiki/Programming-Principles) + - [Suggestions for Getting Started](https://github.com/Bram-Hub/Legup/wiki/Some-Pointers-for-Getting-Started) From 54be367f2e5a9a4594d243c0f6e0ce29dd835bef Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Thu, 21 Jul 2022 13:08:20 -0400 Subject: [PATCH 11/22] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 268917e75..32c7bee54 100644 --- a/README.md +++ b/README.md @@ -33,5 +33,10 @@ All contributions to Legup will be greatly appreciated. Currently, we need the m Please read our [contribution guidelines](CONTRIBUTING.md) for more detailed guidelines on how to contribute to Legup. +## Code of Conduct +> Note: The Code of Conduct is being worked on, the link below does not exist right now. + +You can find our code of conduct and how it is enforced here. + ## License Legup is licensed under the GPL-3.0 license, which can be viewed [here](LICENSE). From 780dcdc045340250bd859fd5040e91d6a6f4a691 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Thu, 21 Jul 2022 15:04:46 -0400 Subject: [PATCH 12/22] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 32c7bee54..f47a486e8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Legup -Legup (Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by Dr. Bram van Heuveln, whose goal is to provide a better interface for students to learn the basic principles of logical reasoning. +Legup (Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by Dr. Bram van Heuveln, whose goal for this project is to provide a better interface for students to learn the basic principles of logical reasoning. > Note: A web version of Legup ([Bram-Hub/LegupWeb](https://github.com/Bram-Hub/LegupWeb)) based on this app version of Legup is actively being developed. However, it is very much in the early stages of development and will not be ready for general use for quite a while. Contributions to both versions of Legup are greatly appreciated. If you are interested in using Legup for educational purposes, please use this app version. From 613b6483252d119a410f51e06a57385344be5dd1 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Fri, 22 Jul 2022 20:03:30 -0400 Subject: [PATCH 13/22] Update README.md --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index f47a486e8..d1cdc1ff8 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,5 @@ All contributions to Legup will be greatly appreciated. Currently, we need the m Please read our [contribution guidelines](CONTRIBUTING.md) for more detailed guidelines on how to contribute to Legup. -## Code of Conduct -> Note: The Code of Conduct is being worked on, the link below does not exist right now. - -You can find our code of conduct and how it is enforced here. - ## License Legup is licensed under the GPL-3.0 license, which can be viewed [here](LICENSE). From d07f2f02c5e93d879cc5dcdb94b6dc5ddd99751d Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Fri, 22 Jul 2022 20:20:29 -0400 Subject: [PATCH 14/22] Update README.md --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d1cdc1ff8..3d3309282 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ -# Legup -Legup (Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by Dr. Bram van Heuveln, whose goal for this project is to provide a better interface for students to learn the basic principles of logical reasoning. +

+ +
+
+ GPL 3.0 License + Discord +
+ A tool to teach formal logic using puzzles +

+
+ +Legup (Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by [Dr. Bram van Heuveln](https://science.rpi.edu/itws/faculty/bram-van-heuveln), whose goal for this project is to provide a better interface for students to learn the basic principles of logical reasoning. > Note: A web version of Legup ([Bram-Hub/LegupWeb](https://github.com/Bram-Hub/LegupWeb)) based on this app version of Legup is actively being developed. However, it is very much in the early stages of development and will not be ready for general use for quite a while. Contributions to both versions of Legup are greatly appreciated. If you are interested in using Legup for educational purposes, please use this app version. From a9c5c5e218e1dd0d3368a072b7ad53cd17ddd933 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Fri, 22 Jul 2022 20:21:10 -0400 Subject: [PATCH 15/22] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3d3309282..578115751 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@

-Legup (Logic Engine for Grid-Using Puzzles), is a better way to learn formal logic. It was created by [Dr. Bram van Heuveln](https://science.rpi.edu/itws/faculty/bram-van-heuveln), whose goal for this project is to provide a better interface for students to learn the basic principles of logical reasoning. +Legup (Logic Engine for Grid-Using Puzzles) is a better way to learn formal logic. It was created by [Dr. Bram van Heuveln](https://science.rpi.edu/itws/faculty/bram-van-heuveln), whose goal for this project is to provide a better interface for students to learn the basic principles of logical reasoning. > Note: A web version of Legup ([Bram-Hub/LegupWeb](https://github.com/Bram-Hub/LegupWeb)) based on this app version of Legup is actively being developed. However, it is very much in the early stages of development and will not be ready for general use for quite a while. Contributions to both versions of Legup are greatly appreciated. If you are interested in using Legup for educational purposes, please use this app version. From 0e80028e145d1d1adc2f1388abb50b86c8732ee4 Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Fri, 22 Jul 2022 20:32:09 -0400 Subject: [PATCH 16/22] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 578115751..879164f24 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ Legup (Logic Engine for Grid-Using Puzzles) is a better way to learn formal logi ## Table of Contents - [Background](#background) - [Use Cases](#use-cases) +- [For Educators](#for-educators) - [Documentation](#documentation) - [Contributing](#contributing) - [License](#license) @@ -34,6 +35,9 @@ So, how does the Legup interface differ from online platforms for grid-based gam Legup also provides a single interface that is capable of supporting many different types of puzzles. Since most of the interface remains the same, however, users wil start to recognize certain similarities between the different puzzles. In particular, since they have to explicitly state their reasoning, users should start to see strong similarities in their logical reasoning patterns from puzzle to puzzle, is the very basis of the abstract logical reasoning principles taught in traditional logic courses. However, rather than being 'thrown in the water' with abstract principles based on obscure symbols, users instead are dealing with a concrete, fun, and engaging logic puzzle. As such, LEGUP aims to give its users a 'leg up' when it comes to the understanding of logic. +## For Educators +If you are an educator interested in using Legup, go to the [releases page](https://github.com/Bram-Hub/Legup/releases) to download the latest release of Legup. You can have your students download Legup from the same page. Some sample puzzle files can be found in the [puzzle files folder](https://github.com/Bram-Hub/Legup/tree/master/puzzles%20files). + ## Documentation ## Contributing From b27b60ac43eb7095aed4338b0e36df4c16ae1d8b Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Fri, 22 Jul 2022 20:32:51 -0400 Subject: [PATCH 17/22] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 879164f24..a70458b4c 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Legup (Logic Engine for Grid-Using Puzzles) is a better way to learn formal logi - [Background](#background) - [Use Cases](#use-cases) - [For Educators](#for-educators) +- [For Students](#for-students) - [Documentation](#documentation) - [Contributing](#contributing) - [License](#license) @@ -38,6 +39,8 @@ Legup also provides a single interface that is capable of supporting many differ ## For Educators If you are an educator interested in using Legup, go to the [releases page](https://github.com/Bram-Hub/Legup/releases) to download the latest release of Legup. You can have your students download Legup from the same page. Some sample puzzle files can be found in the [puzzle files folder](https://github.com/Bram-Hub/Legup/tree/master/puzzles%20files). +## For Students + ## Documentation ## Contributing From 8129d380fa6fc1fa7d2ff2412547cbee72bc5e0c Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Mon, 25 Jul 2022 11:25:44 -0400 Subject: [PATCH 18/22] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a70458b4c..49c0dd01a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@

-Legup (Logic Engine for Grid-Using Puzzles) is a better way to learn formal logic. It was created by [Dr. Bram van Heuveln](https://science.rpi.edu/itws/faculty/bram-van-heuveln), whose goal for this project is to provide a better interface for students to learn the basic principles of logical reasoning. +Legup (**L**ogic **E**ngine for **G**rid-**U**sing **P**uzzles) is a better way to learn formal logic. It was created by [Dr. Bram van Heuveln](https://science.rpi.edu/itws/faculty/bram-van-heuveln), whose goal for this project is to provide a better interface for students to learn the basic principles of logical reasoning. > Note: A web version of Legup ([Bram-Hub/LegupWeb](https://github.com/Bram-Hub/LegupWeb)) based on this app version of Legup is actively being developed. However, it is very much in the early stages of development and will not be ready for general use for quite a while. Contributions to both versions of Legup are greatly appreciated. If you are interested in using Legup for educational purposes, please use this app version. From fa885bc6d09011c63a15d70f19d55c133255370f Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Thu, 28 Jul 2022 14:25:53 -0400 Subject: [PATCH 19/22] Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 49c0dd01a..8f525b3ac 100644 --- a/README.md +++ b/README.md @@ -52,3 +52,20 @@ Please read our [contribution guidelines](CONTRIBUTING.md) for more detailed gui ## License Legup is licensed under the GPL-3.0 license, which can be viewed [here](LICENSE). +``` + Legup: A Better Way to Learn Formal Logic + Copyright (C) 2022, the Legup Developers + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + ``` From a116add718ca1e03400c02ac21234de672e3227a Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Thu, 28 Jul 2022 14:36:39 -0400 Subject: [PATCH 20/22] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f525b3ac..183d736c7 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ The Legup interface allows the user to solve different types of grid-based logic So, how does the Legup interface differ from online platforms for grid-based games? The most important difference is that the Legup interface requires the user to explicitly indicate their logical reasoning. Thus, solving the puzzle due to some lucky guesses is no longer an option! The interface will congratulate the user less on the fact that the user was able to solve the puzzle, but more on how the user solved the puzzle. This is essential to logic: logic is not about the truth or the correct or best answer, but about deductive implication and valid inference: what follows from what, and why? -Legup also provides a single interface that is capable of supporting many different types of puzzles. Since most of the interface remains the same, however, users wil start to recognize certain similarities between the different puzzles. In particular, since they have to explicitly state their reasoning, users should start to see strong similarities in their logical reasoning patterns from puzzle to puzzle, is the very basis of the abstract logical reasoning principles taught in traditional logic courses. However, rather than being 'thrown in the water' with abstract principles based on obscure symbols, users instead are dealing with a concrete, fun, and engaging logic puzzle. As such, LEGUP aims to give its users a 'leg up' when it comes to the understanding of logic. +Legup also provides a single interface that is capable of supporting many different types of puzzles. Since most of the interface remains the same, however, users wil start to recognize certain similarities between the different puzzles. In particular, since they have to explicitly state their reasoning, users should start to see strong similarities in their logical reasoning patterns from puzzle to puzzle, is the very basis of the abstract logical reasoning principles taught in traditional logic courses. However, rather than being 'thrown in the water' with abstract principles based on obscure symbols, users instead are dealing with a concrete, fun, and engaging logic puzzle. As such, LEGUP aims to give its users a "leg up" when it comes to the understanding of logic. ## For Educators If you are an educator interested in using Legup, go to the [releases page](https://github.com/Bram-Hub/Legup/releases) to download the latest release of Legup. You can have your students download Legup from the same page. Some sample puzzle files can be found in the [puzzle files folder](https://github.com/Bram-Hub/Legup/tree/master/puzzles%20files). From 08f48401834e97b360091e9b1e8fc426ffe9fa8c Mon Sep 17 00:00:00 2001 From: Charles <46334090+charlestian23@users.noreply.github.com> Date: Thu, 28 Jul 2022 14:40:24 -0400 Subject: [PATCH 21/22] Update README.md --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 183d736c7..9f2e7ca74 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,11 @@ This project brings about the idea that there are more pedagogically effective w Legup uses a more visual representation in a more concrete and engaging environment. These and other features of the Legup interface are suspected to have several advantages over more traditional interfaces in terms of learning logic. ## Use Cases -The Legup interface allows the user to solve different types of grid-based logical puzzles. Probably the best known example of such a puzzle is the popular Sudoku puzzle, but there are many other types of puzzles that are based on the principle of filling in cells of a square or rectangular grid with different kinds of objects. In all cases, the user is provided certain clues that will force a unique configuration of objects in the grid. These types of puzzles are often advertised as 'logic puzzles', and are claimed to train one's logical mind as, using deduction, users should be able to infer which object goes where. +The Legup interface allows the user to solve different types of grid-based logical puzzles. Probably the best known example of such a puzzle is the popular Sudoku puzzle, but there are many other types of puzzles that are based on the principle of filling in cells of a square or rectangular grid with different kinds of objects. In all cases, the user is provided certain clues that will force a unique configuration of objects in the grid. These types of puzzles are often advertised as "logic puzzles," and are claimed to train one's logical mind as, using deduction, users should be able to infer which object goes where. -So, how does the Legup interface differ from online platforms for grid-based games? The most important difference is that the Legup interface requires the user to explicitly indicate their logical reasoning. Thus, solving the puzzle due to some lucky guesses is no longer an option! The interface will congratulate the user less on the fact that the user was able to solve the puzzle, but more on how the user solved the puzzle. This is essential to logic: logic is not about the truth or the correct or best answer, but about deductive implication and valid inference: what follows from what, and why? +So, how does the Legup interface differ from online platforms for grid-based games? The most important difference is that the Legup interface requires the user to explicitly indicate their logical reasoning. Thus, solving the puzzle due to some lucky guesses is no longer an option! The interface will congratulate the user less on the fact that the user was able to solve the puzzle, but more on how the user solved the puzzle. This is essential to logic. Logic is not about the truth or the correct or best answer, but about deductive implication and valid inference. What follows from what, and why? -Legup also provides a single interface that is capable of supporting many different types of puzzles. Since most of the interface remains the same, however, users wil start to recognize certain similarities between the different puzzles. In particular, since they have to explicitly state their reasoning, users should start to see strong similarities in their logical reasoning patterns from puzzle to puzzle, is the very basis of the abstract logical reasoning principles taught in traditional logic courses. However, rather than being 'thrown in the water' with abstract principles based on obscure symbols, users instead are dealing with a concrete, fun, and engaging logic puzzle. As such, LEGUP aims to give its users a "leg up" when it comes to the understanding of logic. +Legup also provides a single interface that is capable of supporting many different types of puzzles. Since most of the interface remains the same, however, users wil start to recognize certain similarities between the different puzzles. In particular, since they have to explicitly state their reasoning, users should start to see strong similarities in their logical reasoning patterns from puzzle to puzzle, is the very basis of the abstract logical reasoning principles taught in traditional logic courses. However, rather than being "thrown in the water" with abstract principles based on obscure symbols, users instead are dealing with a concrete, fun, and engaging logic puzzle. As such, Legup aims to give its users a "leg up" when it comes to the understanding of logic. ## For Educators If you are an educator interested in using Legup, go to the [releases page](https://github.com/Bram-Hub/Legup/releases) to download the latest release of Legup. You can have your students download Legup from the same page. Some sample puzzle files can be found in the [puzzle files folder](https://github.com/Bram-Hub/Legup/tree/master/puzzles%20files). @@ -53,19 +53,19 @@ Please read our [contribution guidelines](CONTRIBUTING.md) for more detailed gui ## License Legup is licensed under the GPL-3.0 license, which can be viewed [here](LICENSE). ``` - Legup: A Better Way to Learn Formal Logic - Copyright (C) 2022, the Legup Developers +Legup: A Better Way to Learn Formal Logic +Copyright (C) 2022, the Legup Developers - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . ``` From 680e2f3a41d77d76ca43b5bc291e794dc3d7db16 Mon Sep 17 00:00:00 2001 From: Charles Tian <46334090+charlestian23@users.noreply.github.com> Date: Sun, 7 Aug 2022 15:55:02 -0400 Subject: [PATCH 22/22] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9f2e7ca74..cb22c0ead 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,14 @@ Legup also provides a single interface that is capable of supporting many differ If you are an educator interested in using Legup, go to the [releases page](https://github.com/Bram-Hub/Legup/releases) to download the latest release of Legup. You can have your students download Legup from the same page. Some sample puzzle files can be found in the [puzzle files folder](https://github.com/Bram-Hub/Legup/tree/master/puzzles%20files). ## For Students +If you are a student interested in learning the basics of logic, Legup is a great way for you to get started. If your instructor is using Legup in the classroom and you are looking for extra practice, you can reference the sample puzzle files can be found in the [puzzle files folder](https://github.com/Bram-Hub/Legup/tree/master/puzzles%20files) to get more practice. + +Additionally, if you are interested in computer science and programming, please consider contributing to Legup! Not only would it a great way to practice logical reasoning, but it is also a great way to dip your toes into open source software and contributing to open source projects. ## Documentation +Documentation is actively being worked on on the [Legup wiki](https://github.com/Bram-Hub/Legup/wiki). + +Documentation is very much in the early stages, and we would greatly appreciate anyone who is willing to help write and structure the documentation. Currently, the priority is to write detailed documentation on how Nurikabe works, as it is the puzzle that is the most developed within Legup. ## Contributing All contributions to Legup will be greatly appreciated. Currently, we need the most help in the following areas: