forked from tomojitakasu/RTKLIB
-
Notifications
You must be signed in to change notification settings - Fork 362
update installation and README #819
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sbonaime
wants to merge
2
commits into
rtklibexplorer:main
Choose a base branch
from
sbonaime:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| # RTKLIB-EX (previously RTKLIB demo5) | ||
|
|
||
| A version of RTKLIB optimized for low cost GNSS receivers (single, dual, or triple frequency), especially u-blox receivers and based on RTKLIB 2.4.3. This software is provided “AS IS” without any warranties of any kind so please be careful, especially if using it in any kind of real-time application. | ||
|
|
||
| Releases and pre-releases for Windows executables are available at https://github.com/rtklibexplorer/RTKLIB/releases | ||
|
|
||
| Tutorials for this code, and sample GPS data sets are available at http://rtkexplorer.com/ | ||
|
|
||
| The latest version of the user manual is at: https://rtkexplorer.com/pdfs/manual_demo5.pdf | ||
|
|
||
| ============================== | ||
| INSTALLATION & COMPILATION | ||
| ============================== | ||
|
|
||
| --- | ||
| ▶️ **Recommended: CMake (Windows, Linux, macOS)** | ||
| --- | ||
|
|
||
| **Requirements** | ||
| - CMake ≥ 3.16 | ||
| - C/C++ compiler (GCC, Clang, MSVC, ...) | ||
| - Qt5 or Qt6 (for GUI applications) | ||
| - Required modules: Core, Gui, Widgets, SerialPort, Xml, Concurrent | ||
| - Optional: WebEngineWidgets/WebKitWidgets (for maps), LinguistTools (for translations) | ||
|
|
||
| **Steps** | ||
| 1. Create a build directory: | ||
| ```sh | ||
| mkdir build | ||
| cd build | ||
| ``` | ||
| 2. Configure the project: | ||
| ```sh | ||
| cmake .. | ||
| ``` | ||
| - For Release build: | ||
| ```sh | ||
| cmake -DCMAKE_BUILD_TYPE=Release .. | ||
| ``` | ||
| - To specify a custom Qt path: | ||
| ```sh | ||
| cmake -DQt5_DIR=/path/to/Qt5 .. | ||
| ``` | ||
| 3. Build: | ||
| ```sh | ||
| make | ||
| ``` | ||
| 4. (Optional) Run tests: | ||
| ```sh | ||
| make test | ||
| ``` | ||
|
|
||
| Executables will be available in the `bin/` directory after compilation. | ||
|
|
||
| --- | ||
| ▶️ **Windows (Embarcadero) Compilation** | ||
| --- | ||
|
|
||
| **Graphical Applications (GUIs)** | ||
| 1. Open `app/winapp/rtklib_winapp.groupproj` in Embarcadero | ||
| 2. Build | ||
| 3. Install to `../RTKLIB/bin` by running: | ||
| ```bat | ||
| app/winapp/install_winapp.bat | ||
| ``` | ||
|
|
||
| **Console Applications (CUIs)** | ||
| 1. Open `app/consapp/rtklib_consapp.groupproj` in Embarcadero | ||
| 2. Build | ||
| 3. Install to `../RTKLIB/bin` by running: | ||
| ```bat | ||
| app/consapp/install_consapp.bat | ||
| ``` | ||
|
|
||
| --- | ||
| ▶️ **Alternative (Deprecated) Methods** | ||
| --- | ||
|
|
||
| **Linux: Manual Compilation** | ||
|
|
||
| *Console* | ||
| ```sh | ||
| cd app/consapp/<appName>/gcc | ||
| make | ||
| ``` | ||
|
|
||
| *Qt GUI* | ||
| ```sh | ||
| cd app/qtapp | ||
| qmake | ||
| make | ||
| ./install_qtapp | ||
| ``` | ||
|
|
||
| --- | ||
| ▶️ **Binaries & Packages** | ||
| --- | ||
|
|
||
| - Windows: see the [releases page](https://github.com/rtklibexplorer/RTKLIB/releases) | ||
| - Linux: precompiled packages at https://build.opensuse.org/package/show/home:ReimannJens/rtklib-qt | ||
|
|
||
| --- | ||
| ▶️ **CRX2RNX Utility** | ||
| --- | ||
|
|
||
| To decompress CRX-compressed RINEX files, the CRX2RNX utility must be available in your PATH. | ||
| On Linux, rename the command to `crx2rnx`. | ||
| Download: https://terras.gsi.go.jp/ja/crx2rnx.html | ||
File renamed without changes.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section claims CMake is recommended for Windows/Linux/macOS, but the build/test commands use
make/make test, which won’t work with common Windows CMake generators (e.g., Visual Studio) and can differ on macOS too. Consider switching to generator-agnostic commands likecmake --build .andctest, or explicitly documenting that Unix Makefiles (andmake) are assumed.