Skip to content

Commit

Permalink
add project README
Browse files Browse the repository at this point in the history
  • Loading branch information
paulmunyao committed Mar 31, 2024
1 parent b239893 commit 0c4e03d
Show file tree
Hide file tree
Showing 104 changed files with 584 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .bsp/sbt.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"name":"sbt","version":"1.9.9","bspVersion":"2.1.0-M1","languages":["scala"],"argv":["/home/paul/.jdks/openjdk-18.0.2.1/bin/java","-Xms100m","-Xmx100m","-classpath","/home/paul/.local/share/JetBrains/IdeaIC2023.3/Scala/launcher/sbt-launch.jar","-Dsbt.script=/home/paul/.local/share/coursier/bin/sbt","xsbt.boot.Boot","-bsp"]}
{"name":"sbt","version":"1.9.9","bspVersion":"2.1.0-M1","languages":["scala"],"argv":["/usr/lib/jvm/java-11-openjdk-amd64/bin/java","-Xms100m","-Xmx100m","-classpath","/home/paul/.cache/coursier/arc/https/github.com/sbt/sbt/releases/download/v1.7.1/sbt-1.7.1.zip/sbt/bin/sbt-launch.jar","-Dsbt.script=/home/paul/.cache/coursier/arc/https/github.com/sbt/sbt/releases/download/v1.7.1/sbt-1.7.1.zip/sbt/bin/sbt","xsbt.boot.Boot","-bsp"]}
104 changes: 104 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
<a name="readme-top"></a>

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

<!-- PROJECT DESCRIPTION -->

# 📖 Knight's Tour <a name="about-project"></a>

A program that solves the knight tour problem (https://en.wikipedia.org/wiki/Knight%27s_tour)

## 🛠 Built With <a name="built-with"></a>

### Tech Stack <a name="tech-stack"></a>
<ul>
<li><a href="https://scala-lang.org/download/3.4.1.html">Scala</a></li>
<li><a href="https://blog.rockthejvm.com/monads/">Monads</a></li>
</ul>


<p align="left">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## 💻 Getting Started <a name="getting-started"></a>

> To get started with the project, make sure you have installed the following in your computer operating system
### Prerequisites

In order to run this project you need:

Install Scala in your machine if you don't have

Follow this documentation - https://www.scala-lang.org/download/

The link to the above download contains the most used operating systems.

### Setup

Clone this repository to your desired folder:

```sh
git clone https://github.com/paulmunyao/Knight-s-Tour.git
```

### To run the project, execute the following command:

cd into the project

run the following command while inside the project

```
sbt
```
This opens the sbt console

Afterwards run the following command to get the output

```sh
run
```

<p align="left">(<a href="#readme-top">back to top</a>)</p>

<!-- AUTHORS -->

## 👥 Authors <a name="authors"></a>

👤 **Author1**

- GitHub: [@githubhandle](https://github.com/paulmunyao)
- Twitter: [@twitterhandle](https://twitter.com/Mutiso_P)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/paulmunyao/)

<p align="left">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTRIBUTING -->

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/paulmunyao/Knight-s-Tour/issues
<p align="left">(<a href="#readme-top">back to top</a>)</p>


<!-- LICENSE -->

## 📝 License <a name="license"></a>

This project is [MIT](https://github.com/paulmunyao/Knight-s-Tour?tab=MIT-1-ov-file) licensed.

<p align="left">(<a href="#readme-top">back to top</a>)</p>
1 change: 1 addition & 0 deletions project/.bsp/sbt.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"name":"sbt","version":"1.7.1","bspVersion":"2.0.0-M5","languages":["scala"],"argv":["/usr/lib/jvm/java-11-openjdk-amd64/bin/java","-Xms100m","-Xmx100m","-classpath","/home/paul/.cache/coursier/arc/https/github.com/sbt/sbt/releases/download/v1.7.1/sbt-1.7.1.zip/sbt/bin/sbt-launch.jar","-Dsbt.script=/home/paul/.cache/coursier/arc/https/github.com/sbt/sbt/releases/download/v1.7.1/sbt-1.7.1.zip/sbt/bin/sbt","xsbt.boot.Boot","-bsp"]}
1 change: 1 addition & 0 deletions project/project/build.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sbt.version=1.7.1
1 change: 1 addition & 0 deletions project/project/target/active.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"uri":"local:///home/paul/.sbt/1.0/server/a44f71d2674a031b9935/sock"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[[{},{}],{}]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
266828996

Large diffs are not rendered by default.

Empty file.
Empty file.
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
-2132504562
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"{\"organization\":\"org.scala-lang\",\"name\":\"scala-library\",\"revision\":\"2.12.18\",\"configurations\":\"provided\",\"isChanging\":false,\"isTransitive\":true,\"isForce\":false,\"explicitArtifacts\":[],\"inclusions\":[],\"exclusions\":[],\"extraAttributes\":{},\"crossVersion\":{\"type\":\"Disabled\"}}":{"value":{"$fields":["path","startLine"],"path":"(sbt.Classpaths.jvmBaseSettings) Defaults.scala","startLine":3342},"type":"LinePosition"}}
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[debug] not up to date. inChanged = true, force = false
[debug] Updating ProjectRef(uri("file:/home/paul/PROJECTS/Knight's%20Tour/project/project/"), "knight-s-tour-build-build")...
[debug] Done updating ProjectRef(uri("file:/home/paul/PROJECTS/Knight's%20Tour/project/project/"), "knight-s-tour-build-build")
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["sbt.Task[scala.collection.Seq[java.nio.file.Path]]",["/home/paul/PROJECTS/Knight's Tour/project/project/target/scala-2.12/sbt-1.0/zinc/inc_compile_2.12.zip"]]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[]
Empty file.
Empty file.
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[debug] [zinc] IncrementalCompile -----------
[debug] IncrementalCompile.incrementalCompile
[debug] previous = Stamps for: 0 products, 0 sources, 0 libraries
[debug] current source = Set()
[debug] > initialChanges = InitialChanges(Changes(added = Set(), removed = Set(), changed = Set(), unmodified = ...),Set(),Set(),API Changes: Set())
[debug] Full compilation, no sources in previous analysis.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[debug] Copy resource mappings: 
[debug]  
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/home/paul/.sbt/1.0/plugins/target/scala-2.12/sbt-1.0/classes:/home/paul/.sbt/boot/scala-2.12.18/lib/scala-library.jar:/home/paul/.sbt/boot/scala-2.12.18/lib/scala-xml_2.12-2.1.0.jar:/home/paul/.sbt/boot/scala-2.12.18/lib/scala-compiler.jar:/home/paul/.sbt/boot/scala-2.12.18/lib/scala-reflect.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-apiinfo_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-classpath_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/slf4j-api-1.7.36.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/shaded-scalajson_2.12-1.0.0-M4.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/checker-qual-3.4.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/test-interface-1.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/tasks_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/launcher-interface-1.4.2.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/log4j-api-2.17.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-lm-integration_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/gigahorse-apache-http_2.12-0.7.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/scala-library-2.12.18.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jline-builtins-3.24.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/util-cache_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/librarymanagement-ivy_2.12-1.9.3.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/reactive-streams-1.0.3.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/compiler-interface-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/sbt-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/test-agent-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zero-allocation-hashing-0.10.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/template-resolver-0.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/shaded-jawn-parser_2.12-0.9.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/main_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jna-5.13.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/caffeine-2.8.5.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jansi-2.4.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/shaded-apache-httpasyncclient-0.7.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/compiler-bridge_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/lm-coursier-shaded_2.12-2.1.2.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/sjson-new-scalajson_2.12-0.9.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jline-native-3.24.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/sjson-new-murmurhash_2.12-0.9.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/ivy-2.3.0-sbt-396a783bba347016e7fe30dacc60d355be607fe2.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jsch-0.1.54.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/run_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/disruptor-3.4.2.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/core-macros_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/util-interface-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jline-style-3.24.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/log4j-core-2.17.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/scala-reflect-2.12.18.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/sjson-new-core_2.12-0.9.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jna-platform-5.13.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/gigahorse-core_2.12-0.7.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/librarymanagement-core_2.12-1.9.3.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-compile_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-persist_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/scala-xml_2.12-2.2.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/main-settings_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/testing_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/collections_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/ipcsocket-1.6.2.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/error_prone_annotations-2.4.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jline-2.14.7-sbt-9c3b6aca11c57e339441442bbf58e550cdfecb79.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-persist-core-assembly-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/task-system_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-core_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/command_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/util-control_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jline-terminal-3.24.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/sbinary_2.12-0.5.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/scripted-plugin_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jline-reader-3.24.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/logic_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jline-terminal-jna-3.24.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/file-tree-views-2.1.12.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/protocol_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-compile-core_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/io_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/ssl-config-core_2.12-0.6.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/zinc-classfile_2.12-1.9.6.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/scala-parser-combinators_2.12-1.1.2.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/log4j-slf4j-impl-2.17.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/scala-collection-compat_2.12-2.10.0.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/util-position_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/completion_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/jline-terminal-jansi-3.24.1.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/util-relation_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/util-tracking_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/scala-compiler-2.12.18.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/util-logging_2.12-1.9.9.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/config-1.4.2.jar:/home/paul/.sbt/boot/scala-2.12.18/org.scala-sbt/sbt/1.9.9/actions_2.12-1.9.9.jar
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/home/paul/PROJECTS/Knight's Tour/project/project/target/scala-2.12/sbt-1.0/classes
Loading

0 comments on commit 0c4e03d

Please sign in to comment.