Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Equat-ion committed Jan 20, 2025
1 parent aac1cb6 commit aa26be8
Showing 1 changed file with 1 addition and 27 deletions.
28 changes: 1 addition & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,6 @@
- **Cross-platform Compatibility**: The app supports Windows, macOS, and Linux, storing data in appropriate system-specific directories.
- **Modular Frontends**: Choose your preferred user interface, whether graphical or text-based.

### Directory Structure

```
permutations/
├── core/
│ ├── __init__.py
│ ├── core_app.py # Main application logic
│ ├── database.py # Handles JSON-based storage
│ └── encryption.py # Handles encryption and decryption
├── frontends/
│ ├── qt6/ # Qt6 GUI for KDE
│ ├── gtk4/ # GTK4 Libadwaita GUI for GNOME
│ ├── winui/ # WinUI Mica interface for Windows
│ └── tui/ # Text-based user interface
├── README.md # Project documentation
└── requirements.txt # Python dependencies
```

### Requirements

Expand Down Expand Up @@ -70,20 +53,11 @@ permutations/

- **UI Enhancements**: Full support for modular frontends.
- **Windows Installer**: Easy-to-use installer for Windows users.
- **Icon Design**: Custom app icon for better branding.

### Security Considerations

- Ensure the encryption key is securely stored and not exposed.
- Use the application in a trusted environment to prevent unauthorized access.

### Contributing

Contributions are welcome! Feel free to fork the repository and submit a pull request.

### License
Contributions are welcomed! Feel free to submit a pull request or Contact me.

This project is licensed under the GNU GPL v3 License.

---

Expand Down

0 comments on commit aa26be8

Please sign in to comment.