From f18dbbcaec20e9a678d900c1b933de37fa70e119 Mon Sep 17 00:00:00 2001 From: Wellington Gabriel Vicente de Souza <wellingtongabrielvs@gmail.com> Date: Wed, 21 Mar 2018 20:39:31 -0300 Subject: [PATCH] add basic readme.md file --- T2/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 T2/README.md diff --git a/T2/README.md b/T2/README.md new file mode 100644 index 0000000..654b1d7 --- /dev/null +++ b/T2/README.md @@ -0,0 +1,29 @@ +# STEAMDB V0.0.1 +### dependencies: latest version of ruby (2.5.0), active\_record gem, sqlite3 gem + +## Introduction +Hi! This is a project made for the second evaluation of the Tópicos em Programação de Computadores (CI320) course at Universidade Federal do Paraná in Brazil. + +This project simulates a simplified working database management system similar to sqlite3. It was implemented in the Ruby language and it uses the Active Record gem to establish a connection with sqlite3. + +## How to use +### Creating the database +To create the tables defined in the schema.rb file, run: +$ ruby schema.rb + +The steamdb.sqlite3 file on this repository already contains a few example rows to simplify the testing of the different functionalities. To reset the entire database, simply delete the steamdb.sqlite3 file and run the schema.rb file again. + +The models for each object type are defined in the models.rb file. This database system implements 1 to 1, 1 to n and n to n relationships. + +### Running SteamDB +To run SteamDB, just enter the following command on your terminal: +$ ruby steamdb.rb + +### Instructions +This program contains four basic functionalities: + - insere (add a new element) + - exclui (remove one or more elements) + - altera (update one or more elements) + - lista (list all the elements of a table) + +### Command syntax -- GitLab