Update README.md

2024-09-28 15:04:58 +02:00
parent 617c26f6a1
commit af7e664012
1 changed files with 96 additions and 1 deletions
@@ -1 +1,96 @@
-# BECOE
+# USI Economics Repository - BECOE
+
+Welcome to the USI Economics Repository! This repository is maintained by Quintavalle Pietro for students of the Università della Svizzera italiana (USI). It serves as a platform for consulting, sharing, and contributing notes and materials for the Bachelor of Arts in Economics program.
+
+## Repository Structure
+
+The repository is organized as follows:
+
+```
+BECOE/
+│
+├── Source Material/
+│   ├── Books/
+│   └── Slides/
+│
+├── Principles of Accounting/
+├── Principles of Management/
+├── Principles of Finance/
+├── Principles of Economics and Sustainable Development/
+└── Mathematics: Analysis/
+```
+
+## Courses
+
+This repository contains materials for the following courses:
+
+1. Principles of Accounting
+2. Principles of Management
+3. Principles of Finance
+4. Principles of Economics and Sustainable Development
+5. Mathematics: Analysis
+
+## Contributing
+
+We welcome contributions from all USI Economics students! Here's a step-by-step guide on how to contribute:
+
+1. Fork the repository:
+   - Go to the main page of this repository
+   - Click the "Fork" button in the top-right corner
+
+2. Clone your forked repository:
+   ```
+   git clone https://github.com/your-username/USI-Economics-Repository.git
+   cd USI-Economics-Repository
+   ```
+
+3. Create a new branch for your contribution:
+   ```
+   git checkout -b your-branch-name
+   ```
+
+4. Add or modify content in the appropriate folder
+
+5. Stage your changes:
+   ```
+   git add .
+   ```
+
+6. Commit your changes:
+   ```
+   git commit -m "Brief description of your changes"
+   ```
+
+7. Push your changes to your fork:
+   ```
+   git push origin your-branch-name
+   ```
+
+8. Create a pull request:
+   - Go to the main page of your forked repository
+   - Click on "Pull requests"
+   - Click the "New pull request" button
+   - Select your branch and review your changes
+   - Click "Create pull request"
+   - Provide a clear title and description for your pull request
+   - Submit the pull request
+
+Please ensure that your contributions are relevant, accurate, and properly formatted.
+
+## Reporting Issues
+
+If you find an error or notice that something is missing, please open an issue:
+
+1. Go to the "Issues" tab in the repository
+2. Click on "New Issue"
+3. Provide a clear title and description of the problem
+4. Include the course name and specific material you're referring to
+5. Submit the issue
+
+We appreciate your help in improving this resource for all USI Economics students!
+
+## Contact
+
+If you have any questions or suggestions, please feel free to contact the repository maintainer, Quintavalle Pietro.
+
+Happy studying!