Merge pull request #1 from jvdcf/initialConfig

Initial config

Author: DuarteSAssuncao

.gitignore

@@ -30,3 +30,8 @@
 *.exe
 *.out
 *.app
+
+# CLion IDE
+cmake-build-debug/
+.idea/
+docs/output/

CMakeLists.txt

@@ -0,0 +1,28 @@
+cmake_minimum_required(VERSION 3.26)
+project(AED2324_PRJ1_G23)
+
+set(CMAKE_CXX_STANDARD 11)
+
+# Doxygen Build
+find_package(Doxygen)
+if(DOXYGEN_FOUND)
+    set(BUILD_DOC_DIR "${CMAKE_SOURCE_DIR}/docs/output")
+    if(NOT EXISTS "${BUILD_DOC_DIR}")
+        file(MAKE_DIRECTORY "${BUILD_DOC_DIR}")
+    endif()
+
+    set(DOXYGEN_IN "${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile")
+    set(DOXYGEN_OUT "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile")
+    configure_file("${DOXYGEN_IN}" "${DOXYGEN_OUT}" @ONLY)
+
+    message("Doxygen build started")
+    add_custom_target(Doxygen ALL
+            COMMAND "${DOXYGEN_EXECUTABLE}" "${DOXYGEN_OUT}"
+            WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
+            COMMENT "Generating API documentation with Doxygen"
+            VERBATIM)
+else(DOXYGEN_FOUND)
+    message("Doxygen needs to be installed to generate the documentation.")
+endif(DOXYGEN_FOUND)
+
+add_executable(AED2324_PRJ1_G23 main.cpp)

Readme.md

@@ -9,10 +9,8 @@ Duarte Assunção, Guilherme Matos, João Ferreira
 #### ToDo
 
 1. *Parse data:* Ler e guardar a informação em memória (vice-versa)
-   > [!IMPORTANT]
-   > Ainda por decidir as bases de dados a usar para cada classe.
-3. Funcionalidades de gestão de horários
-4. Listagens de dados (totais e parciais)
+2. Funcionalidades de gestão de horários
+3. Listagens de dados (totais e parciais)
    > [!IMPORTANT]
    > Ainda por decidir. Alguns exemplos dados na descrição do projeto:  
    > "i.Consult the schedule of a given student or class;  
@@ -21,11 +19,22 @@ Duarte Assunção, Guilherme Matos, João Ferreira
    > iv.Consult the class/year/UC occupation (sorting by UC, ascending or descending order, …);  
    > v.Consult the UCs with the greatest number of students;"  
    
-5. Pedidos de mudanças
+4. Pedidos de mudanças
    - Mudanças de cadeiras
    - Mudanças de turmas
-7. Registo cronológico de todas as mudanças e permitir restauro de mudanças recentes
-8. Documentação Doxygen
+5. Registo cronológico de todas as mudanças e permitir restauro de mudanças recentes
+6. Documentação Doxygen
+
+---
+
+#### Estrutura em memória
+> [!NOTE]
+> Este ainda é um design inicial e está suscetível a alterações, nomeadamente a favor de eficiência em certa funções.
+
+A informação será guardada em memória numa estrutura muito semelhante aos ficheiros .csv.  
+Isto facilita imenso o parsing, porém ao custo da eficiência de algumas funções.
+
+Por cada ficheiro ``x.csv``, haverá uma classe ``appX`` que terá todos os seus métodos e um vetor de classes ``x`` que cada um representa uma linha do ficheiro.
 
 ---