Merge branch 'aquanauts:main' into main

aquanauts · Jul 3, 2024 · 27b1fd6 · 27b1fd6
2 parents 45dbc01 + c4622b4
commit 27b1fd6
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 52 deletions.
diff --git a/.gitignore b/.gitignore
@@ -233,8 +233,8 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 
-# Editor-based Rest Client
-.idea/httpRequests
+# Ignore idea project files
+.idea
 
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser

diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/alogamous.iml b/.idea/alogamous.iml
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/README.md b/README.md
@@ -7,10 +7,21 @@
 
 ## Table of Contents
 
+- [Description](#description)
 - [Installation](#installation)
 - [Development](#development)
 - [License](#license)
 
+## Description
+A Python program that can process log files and generate a daily report on anomalies in a set of logs.
+- It should be able to read multiple files and output an html-formatted file.
+- It should have multiple metrics/checks for anomalous log lines.
+- It should be able to take in a log line format so that it knows how to extract useful information from a log line.
+- It should be able to traverse a well-defined file system structure to access all logs.
+- It should be able to generate metrics that span multiple files.
+- It should be well-tested.
+
+
 ## Installation
 
 ```console