|
|
@@ -1,42 +1,29 @@
|
|
|
# openPilotLog
|
|
|
|
|
|
+Welcome to openPilotLog, the free and open source airline pilot logbook application!
|
|
|
|
|
|
-Airline pilots are required to maintain a logbook containing details of their flights. These logbooks were historically written by hand on paper, but of course nowadays more and more people are doing it electronically, be it in their own excel sheet or using a professional logbook software.
|
|
|
+## Tl;dr
|
|
|
|
|
|
-I have used professional solutions for many years, and have seen more and of them move from being a one-time purchase to becoming a "Logbook as a Service" type subscription. After the one I have been using for the last couple of years, and had bought a "lifetime license" for ended up announcing they also moved to a subscription based service, I decided that I've had enough of it.
|
|
|
+Airline pilots are required to maintain a logbook containing details of their flights. These logbooks were historically written by hand on paper, but of course nowadays more and more people are doing it electronically, be it in their own excel sheet or using a paid logbook software.
|
|
|
|
|
|
-As a long-time FOSS enthusiast, I wondered why there wasn't a good open and free alternative available, so I decided to create my own. Since I have used and benefited from free and open source software for a long time, I decided to also create this project as FOSS.
|
|
|
+I have used paid solutions for many years, and have seen more and of them move from being a one-time license purchase to becoming a "Logbook as a Service" type subscription. After the one I have been using for the last couple of years, and had bought a "lifetime license" for ended up announcing they also moved to a subscription based service, I decided that it is time for a free and open source alternative that is fast, easy to use, and does not require a subscription.
|
|
|
|
|
|
-All that being said, while I know how to fly an aircraft, I never properly learned how to code, so if you are a professional programmer and your eyes are bleeding from what you're seeing or I am doing something immensely stupid, please do let me know! This project is my way of learning how to code, so I am more than open to feedback.
|
|
|
+## The state of the project!
|
|
|
|
|
|
-# What are the design principles of this program?
|
|
|
+openPilotLog is currently in development, so no release is provided yet. If you would like to be informed about upcoming releases, you can [subscribe](https://turowsky.eu/?page_id=112) to our newsletter.
|
|
|
|
|
|
-Code: C++ (Qt5)
|
|
|
-
|
|
|
-Database: sqlite3
|
|
|
-
|
|
|
-This program is suppposed to replace a paper logbook with an electronic version. As a first step, I want to focus on the basics, and then add 'nice-to-haves' later.
|
|
|
-These are the guidelines for this project:
|
|
|
-- Speed: openPilotLog is supposed to be fast, lean and efficient. I have settled on using the Qt framework for the gui and code, as well as sqlite for the database.
|
|
|
-- Cross-Platform Support: I am primarily using Linux, but Windows and Mac (and maybe down the road iOS/Android) should also be supported. Qt provides this cross-platform compatibility.
|
|
|
-- Local: At the moment, I am not planning on implementing a cloud-sync solution. The database is local, on your machine, and moving it around should be as easy as copying it onto a USB stick. While I am not opposed to cloud syncing functionality, I want the application to be independent of external services.
|
|
|
-- Free: This application is and always will be free to use, distribute and modify. I have used commercial solutions before and have been disappointed when a 'lifetime' license expired because the company needs to support their development and cloud infrastructure. That's fair enough, but I believe keeping a logbook of your flights is not rocket science and you should not have to pay a monthly subscription for that.
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-# The state of the project - Should I use this?
|
|
|
-
|
|
|
-Clear answer for the time being - Don't use it. This is an early development stage and functionality, layout of the GUI etc. might change drastically. For this reason, I am not providing a release for now. If you would like to test it, you'll have to compile the project yourself.
|
|
|
+If you want to learn more about this project, check out the [wiki](https://github.com/fiffty-50/openpilotlog/wiki) or the [blog](https://turowsky.eu/)!
|
|
|
|
|
|
+For developers, the code documentation can be found at our [doxygen](https://fiffty-50.github.io/openpilotlog/) pages. If you are interested in contributing to the project, you can get in touch [here](mailto:felix.turo@gmail.com?subject=[GitHub]%20Contributing%20to%20openPilotLog).
|
|
|
|
|
|
# How does it look like?
|
|
|
|
|
|
Here are some early screenshots:
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-# But I want to try it!
|
|
|
+
|
|
|
|
|
|
-The most straight forward way is to get a copy of Qt https://www.qt.io/download and compile the project using QtCreator and qmake, the PRO file is included in this repository. After building, make sure to place a copy of the sample database in the application/data folder - this folder will be created the first time you run the application. Make sure you are placing the database in the folder the application is executed from. If you want to start a fresh logbook, rename and place the empty sample database into the application folder. Without a valid database, the application will not start.
|
|
|
+
|
Felix