diff --git a/README.md b/README.md index 5acbca2..a36ee17 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ### Notable Mention: -the repository called helpertransfer contains all game play code and menus however time expired before I was able to debug effectively. The issues appeared upon attempting to utilize helper files. The main repository contains fully functional code for setting up a game which includes all crud requirements for all 3 classes. Code breaks at the point of starting the gameplay post setup. +The repository branch called helpertransfer contains all game play code and menus however time expired before I was able to debug effectively. The issues appeared upon attempting to utilize helper files. The main repository contains fully functional code for setting up a game which includes all crud requirements for all 3 classes. Code breaks at the point of starting the gameplay post setup. --- @@ -16,7 +16,7 @@ Monopoloython utilizes the command line interface(cli) as the access point for u This program relies upon a python interpreter and pip files to manage the virtual environment. Monopolython takes advantage of a handful of python libraries and modules to facilitate its functions. -Monopolython relies heavily upon Sqlite3 for its database interfacing and management. Monopolython takes advantage of the tools provided through the installed packages Rich and Pick to augment the graphical organization, presentation, and enhanced interactive features not found in native python libraries. I have imported the python libraries: time, os, random, ipdb, and sqlite3 as each offers tools that enable a more comfortable user experience. Primarily the libraries I've imported help manage the navigation of application menus in a way that makes them easier to read and assist in the speed in which information is presented to the user. +Monopolython relies heavily upon Sqlite3 for its database interfacing and management. Monopolython intendes to take advantage of the tools provided through the installed packages Rich and Pick to augment the graphical organization, presentation, and enhanced interactive features not found in native python libraries. I have imported the python libraries: time, os, random, ipdb, and sqlite3 as each offers tools that enable a more comfortable user experience. Primarily the libraries I've imported help manage the navigation of application menus in a way that makes them easier to read and assists in the speed at which information is presented to the user. @@ -45,7 +45,7 @@ Take a look at the directory structure: ## Generating Your Environment -upon installation of the program, users must first setup the virtual environment by running +Upon installation of the program, users must first setup the virtual environment by running the following commands: ```console pipenv install @@ -57,16 +57,16 @@ pipenv shell ## Database Organization and Relationships ![Schema] (./lib/assets/Monopolython(3).png) -4 tables reside within the database to organize and store game data for both during game_setup +4 tables reside within the database to organize and store game data for both game_setup and synchronous data storage and retrieval during game play. ![alt text]() -This diagram dipicts the One to Many relationships between the Games table and both the Players and Game_spaces tables. +This diagram dipicts the One to Many relationships between the Games tablem and both the Players and Game_spaces tables. -The Spaces table is a unique table that is static. It is the root source of game information that exists for every game encounter. +The Spaces table is a unique table that is static. It is the root source of game information that exists for every game encounter. It has only a single boolean attribute that is updated during gameplay. giving it a one to many relationship with the games table but no others. -The CLI menus are designed to offer users a small number of options to navigate their way through the game experience. Starting with the game setup, the diagram below offers a roadmap of the flow of the program throughout the beginning of the game. +The CLI menus are intentionally designed to offer users a small number of options as they navigate their way through each menu, avoiding the cumbersome experience of over laden tables with excessive user options. Starting with the game setup, the diagram below offers a roadmap of the flow of the program throughout the beginning of the game. This road map was created during inception and does not identically map to the game flow. I attempted to utilize an AGILE-like approach in creating this app meaning I was consistently checking functionality and subjectively measuring the user experience as the program was being built. ![alt text](lib/assets/gameboard2.jpg)