Add README.md and LICENSE

This commit is contained in:
Edward Betts 2023-10-06 19:27:46 +01:00
parent 6331b65c18
commit 812f7c8a07
2 changed files with 76 additions and 0 deletions

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 Edward Betts <edward@4angle.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

55
README.md Normal file
View file

@ -0,0 +1,55 @@
# Brittany Ferries price and availability checker
This tool allows you to check the prices and availability of Brittany Ferries for various routes. You can specify the departure and arrival ports, travel dates, and other options to get accurate pricing information.
## Usage
### Prerequisites
Before using this tool, make sure you have the following Python modules installed:
- flask
- sqlalchemy
- lxml
- jinja2
You can install these modules using pip:
```bash
pip install flask sqlalchemy lxml jinja2
```
### Running the Tool
1. Clone this repository or download the files to your local machine.
2. Make sure you have Python 3 installed.
3. Open a terminal and navigate to the directory where you saved the files.
4. Run the `main.py` script:
```bash
python main.py
```
5. Open your web browser and visit `http://localhost:5000` to access the tool.
## Features
- Check prices and availability for various ferry routes to France.
- Specify the number of adults, small dogs, and other options for accurate pricing.
- View cabin accommodations and details.
- See the duration of each crossing.
## Configuration
You can configure the tool by editing the `config.ini` file in the `~edward/config/brittany-ferries/` directory. Make sure to provide accurate details for your vehicle and travel preferences.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
If you encounter any issues or have questions about this tool, you can contact the developer, Edward Betts, at `edward@4angle.com`.