From bbd65de1611b04afd044c1b575beac886b3d762b Mon Sep 17 00:00:00 2001 From: JakobPreiss Date: Fri, 17 Jan 2025 09:34:04 +0100 Subject: [PATCH] read.me now ready? --- README.md | 6 ++--- ReadME.txt | 76 ------------------------------------------------------ 2 files changed, 3 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index f1889b0..62ec3fe 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ ## Table of Contents -- [General Description](#General Description) +- [General Description](#General) - [Outlook](#Outlook) -- [How to setup our Chess-Game](#How to setup our Chess-Game) -- [How to play](#How to play) +- [How to setup our Chess-Game](#How) +- [How to play](#How) - [Preview](#preview) ### General Description diff --git a/ReadME.txt b/ReadME.txt index 7fbfc57..e69de29 100644 --- a/ReadME.txt +++ b/ReadME.txt @@ -1,76 +0,0 @@ -## JP Morgan Chess -![Static Badge](https://img.shields.io/badge/Scala-sbt-red?style=for-the-badge&logo=Scala&logoColor=%23dc322f&color=%23dc322f) -![Coverage Status](https://coveralls.io/repos/github/philippeZim/JP_Morgan_Chess/badge.svg?branch=feature/CI) -![GitHub contributors](https://img.shields.io/github/contributors/philippeZim/JP_Morgan_Chess) -![GitHub Created At](https://img.shields.io/github/created-at/philippeZim/JP_Morgan_Chess) -![GitHub last commit](https://img.shields.io/github/last-commit/philippeZim/JP_Morgan_Chess) -![GitHub repo size](https://img.shields.io/github/repo-size/philippeZim/JP_Morgan_Chess) - -### General Describtion -This repository marks the plane on which the glorious quest of phillipe and jakob takes place. -A Quest to build their own Chess Game!!! -They are only armed with the programming language scala, the build tool sbt and their wits. -Will the classes of Marco Boger and the depths of the internet be enough for them to figure it out? -Will they prevail in thier journey to a full working chess game? -Will they achieve their goal and resist the sweet temptation of Variables and loops to ascend to fully functional programming? -Find yourselves in our comfy repository on a regular basis to see their latest achievements. - -### How to setup our Chess-Game - -To play Chess with our glorious implementation one must prepare. -Follow these steps, young lad': - -First, one must download the scala programming language from it's source. -Look here: -https://www.scala-lang.org/download/ - -Secondly, one must install the SBT! The Scala Build Tool! -This is used to actually run our code in a virtual machine? - -As a third step one should create a new folder to save our little chess game files. - -And as a fourth step: -open a terminal of your choosing and go to your created folder -Now, behold the mighty words as you type them into your console: -git clone https://github.com/philippeZim/JP_Morgan_Chess - -### How to play - -Even the dumbest bafoon could perform the necessary steps. -Simply type: -sbt run -into your console. - -Before you will rise a chessboard. -You will be asked to move. To make a move you simply have to type in the field from -which you wish to move and the field that marks the new intended position of your chosen Piece. -Choose your formatting carefully. It should always look like this: e2e4 - -But be warned: should your command defy the holy rules of Chess. The Game will not hesiate -to scold you in worse ways than your tiny brain could comprehend! - -Now: - -### Start Playing - -### Example output - -```scala - +-----+-----+-----+-----+-----+-----+-----+-----+ -8 | r | n | b | q | k | b | n | r | - +-----+-----+-----+-----+-----+-----+-----+-----+ -7 | p | p | p | p | p | p | p | p | - +-----+-----+-----+-----+-----+-----+-----+-----+ -6 | . | . | . | . | . | . | . | . | - +-----+-----+-----+-----+-----+-----+-----+-----+ -5 | . | . | . | . | . | . | . | . | - +-----+-----+-----+-----+-----+-----+-----+-----+ -4 | . | . | . | . | . | . | . | . | - +-----+-----+-----+-----+-----+-----+-----+-----+ -3 | . | . | . | . | . | . | . | . | - +-----+-----+-----+-----+-----+-----+-----+-----+ -2 | P | P | P | P | P | P | P | P | - +-----+-----+-----+-----+-----+-----+-----+-----+ -1 | R | N | B | Q | K | B | N | R | - +-----+-----+-----+-----+-----+-----+-----+-----+ - a b c d e f g h \ No newline at end of file