Add .gitignore file and update README and implementation plan documentation

README.md

@@ -2,14 +2,13 @@
 
 A web application to plan mining projects and estimate costs, returns and profitability.
 
-## Tech Stack
+Focuses on ore mining operations and covering parameters such as capital and operational expenditures, resource consumption, production output, and Monte Carlo simulations for risk analysis.
 
-- **Backend**: Python 3.10+ (FastAPI)
-- **Database**: PostgreSQL
-- **Frontend**: (TBD)
-- **Testing**: pytest
+The system is designed to help mining companies make informed decisions by simulating various scenarios and analyzing potential outcomes based on stochastic variables.
 
-## Planned Features
+A range of features are implemented to support these functionalities.
+
+## Features
 
 - **Scenario Management**: The database supports different scenarios for what-if analysis, with parent-child relationships between scenarios.
 - **Monte Carlo Simulation**: The system can perform Monte Carlo simulations for risk analysis and probabilistic forecasting.
@@ -21,6 +20,18 @@ A web application to plan mining projects and estimate costs, returns and profit
 - **Equipment Management**: The system manages equipment and their operational data.
 - **Maintenance Logging**: It includes a log for equipment maintenance events.
 
+## Architecture
+
+The architecture is documented in [docs/architecture.md](docs/architecture.md).
+
+## Development
+
+The development setup instructions are provided in [docs/development_setup.md](docs/development_setup.md).
+
+## Testing
+
+Testing guidelines and best practices are outlined in [docs/testing.md](docs/testing.md).
+
 ## Database Objects
 
 The database is composed of several tables that store different types of information. All tables are under schema `bricsium_platform`. See `structure.sql` for full DDL. Here are some of the most important ones: