mirror of https://github.com/gmbrax/Pilgrim.git
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# Pilgrim
|
|
|
|
## Overview
|
|
|
|
**Pilgrim** is a Python-based travel diary application designed to help users document and manage their travel
|
|
experiences. The project provides tools for recording trips, organizing travel notes, and storing memories in a
|
|
structured and accessible format.
|
|
|
|
## Features
|
|
|
|
- Create and manage travel diaries
|
|
- Add, edit, and delete travel entries
|
|
- Organize trips by date, location, or theme
|
|
- Store photos and add them to the diary entry
|
|
|
|
## Requirements
|
|
- Python 3.8 or higher
|
|
- Linux operating system (tested on Ubuntu 20.04+)
|
|
- Visual Studio Code (VSCode) for development (optional but strongly recommended)
|
|
- pip (Python package installer)
|
|
- Optional: virtualenv for isolated environments
|
|
|
|
## Installation
|
|
|
|
To install the application you must issue the command:
|
|
|
|
```bash
|
|
pip install pilgrim
|
|
```
|
|
|
|
## Usage
|
|
|
|
To use application you just issue:
|
|
```bash
|
|
pilgrim
|
|
```
|
|
|
|
This will start the Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.
|
|
|
|
## Changelog
|
|
|
|
To see all the changes in the current version, please refer to the [CHANGELOG](CHANGELOG.md)
|
|
|
|
## License
|
|
|
|
This project is licensed under the BSD 3-Clause License — see the [LICENSE](LICENSE) file for details.
|