Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eduardobaginskicosta committed May 12, 2024
1 parent bdb9de6 commit 28beae2
Showing 1 changed file with 25 additions and 11 deletions.
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- EXTERNAL LINKS -->

[url_visual_studio]: https://visualstudio.microsoft.com/en-us/
[url_unifatecie]: https://www.unifatecie.edu.br/
[url_windows]: https://www.microsoft.com/en-us/windows/
[url_cmake]: https://cmake.org/
Expand All @@ -10,28 +11,41 @@
<h1 align="center">Bookshelf</h1>

<img
aria-label="Simple CRUD system created to manage books, written in C++."
aria-label="Simplified CRUD system for book management, written in C++."
src=".\Assets\Bookshelf.png"
/>

<!-- GET STARTED -->

# 📘 Get Started
## 📘 Get Started

**Bookshelf** is a simplified CRUD system written in [C++][url_cpp] as part of an
academic project for the **Data Structures** course at
[UniFatecie University][url_unifatecie].
The **Bookshelf** project is a simplified CRUD system, written in [C++][url_cpp],
developed as part of an academic assignment for the **Data Structure** course at the
[UniFatecie University Center][url_unifatecie].

The context is that you are a programmer who has accumulated a collection of books read throughout your life. However, you felt the need to create a program to manage them, registering all the books in the system. One day, you decided to start donating some of the books and had to implement the option to remove donated books from the system.
<!-- PROPOSAL -->

## 📄 Context of Academic Work

In short, you are a programmer who has accumulated various books throughout your life and
felt the need to create a program to manage them, registering all of them. After years,
you decided to donate some books and, for that, you needed to implement a system to
remove them from your system. Applying your knowledge about data structure, you start
programming.

> **Note:** This context was partially followed, since the need was just to program a
> simple system to remove data from a system. To take advantage of the repository, I
> decided to create a complete simple CRUD system.
<!-- BUILD APPLICATION -->

# ⚙️ Build Application
## ⚙️ Build Application

This project was developed using the [CMake][url_cmake] ecosystem. No system-specific
headers were used, which means it can be easily ported to any operating system.

This project was developed using the [CMake][url_cmake] build environment. Currently, it
has pre-configuration for the [Microsoft Windows][url_windows] platform, but it does not
rely on specific system packages. **Therefore, it can be easily ported to other operating
systems**.
**If you are using [Microsoft Windows][url_windows], I recommend using
[Visual Studio][url_visual_studio].**

---

Expand Down

0 comments on commit 28beae2

Please sign in to comment.