GHMiranda
/
Pilgrim
mirror of https://github.com/gmbrax/Pilgrim.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Gustavo Henrique Miranda 2025-07-07 02:06:28 -03:00 committed by GitHub
parent 483c4b8529
commit 543916a1a1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -1,16 +1,17 @@
# Python_Pilgrim
# Pilgrim
## Overview
**Python_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.
**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, notes, and other media
- Export and share travel logs
- Store photos and add them to the diary entry
## Requirements
- Python 3.8 or higher
@ -21,30 +22,25 @@
## Installation
1. Clone the repository:
```bash
git clone https://github.com/gmbrax/Pilgrim.git
```
2. Navigate to the project directory:
```bash
cd Pilgrim
```
3. Create a virtual environment and, then, activate it:
```bash
python -m venv .venv
source .venv/bin/activate
```
4. Install the required dependencies:
```bash
pip install -r requirements.txt
```
To install the application you must issue the command:
```bash
pip install pilgrim
```
## Usage
To run the main application, execute:
To use application you just issue:
```bash
python <???>.py
pilgrim
```
This will start the Python_Pilgrim application. Follow the on-screen instructions to create and manage your travel diaries.
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.