aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* docs: --user is only required when docker run as rootHugo Osvaldo Barrera2025-09-231-4/+12
| | | | | | | | | | | | The --user argument attempts to map the uid of the user inside the container to the user in the host. This works if docker is running as root, but is docker is running as the current user, then the uid in the container is mapped to a surrogate uid on the host, and this surrogate user does not have permissions to complete the build process. Clarify that the --user flag is only required when running docker as root. It is also likely not required by users using podman as a docker drop-in replacement, since podman always runs in rootless mode.
* docs: remove superfluous linkHugo Osvaldo Barrera2025-09-231-1/+1
| | | | | | The docker build section points to another page with instructions on how to clone the repository, but this same page already contains these same instructions in the previous section.
* docs: shuffle sections into logical orderHugo Osvaldo Barrera2025-09-231-29/+35
| | | | | | | | | The first section explains how to clone the repository, the second how to build Infinitime with the docker image, but the details on actually provisioning the image are at the end, despite this step taking place before the build itself. Move the sections into the order in which the steps should be followed.
* Fix nRF SDK download links (#2270)Darius Arnold2025-05-211-1/+1
| | | nRF has moved the download to a new location- Update the build script to fetch from the same URL the download website currently provides.
* Revert "docs: add git config items to docs"Max Jakobitsch2025-03-212-11/+2
| | | | This reverts commit 4066cc03004c89a7ac4d5a7a327729184ecac7b6.
* docs: add git config items to docsMax Jakobitsch2025-03-212-2/+11
|
* Update Apps.mdLukas H.2025-03-211-1/+1
|
* make cmake command coherent with previous documentationLionel Elie Mamane2025-03-211-1/+1
|
* README: Header redesign (#2032)liamcharger2024-10-231-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Reformat README.md * Update README.md * Add files via upload * Add files via upload * Add new README.md header image * Remove unnecessary <br> tag * Scale watchface logo down; add downloads badge * Remove unnecessary <br> tag * Add <br> tag to maintain spacing consistency * Remove incorrect link * Add watchface logo with dark logo * Replace logo image with dark version * Add files via upload * Add header image * Fix row spacing in header image * Remove unnecessary <br> tag * Add corner radius to header image * Add files via upload * Update image background * Add reference to InfiniTimeExplorer * Remove unnecessary image * Remove unnecessary image * Remove unnecessary images * Rename watchface_collage_no_shadow.png to watchface_collage.png * Update header image URL * Remove unnecessary <br> tag * SPI transaction hooks * Remove task to notify * Refactor display WriteToRam * Use functional abstraction for hooks * Refactor lambdas * Avoid storing lambda * Rename to pre-transaction hook * Use FreeRTOS delay instead of spinning the CPU * Apply display driver datasheet delays * Move includes back * Include task header (Fixes sim) * Make chime vibrate twice * Remove commit from main * README: improve wording * Add bootloader to DeviceInformationService.cpp * Add bootloader to DeviceInformationService.h * Revert "Add bootloader to DeviceInformationService.h" This reverts commit f3f0fd568d96dea1ebd30529b4b8b6d5f4d5444b. * Revert "Add bootloader to DeviceInformationService.cpp" This reverts commit 35570edafab1b061442ae89b01a2ced8b9a812bd. * Delete doc/logo/watchface_collage.png * Add files via upload * Delete doc/logo/watchface_collage.png * Add files via upload * Replace collage with correct image --------- Co-authored-by: mark9064 <30447455+mark9064@users.noreply.github.com>
* Documentation improvements (#2091)Derry Tutt2024-08-1832-11/+147
| | | | | | Add documentation about watch faces and applications. Update getting started documentation. Co-authored-by: tituscmd <154823939+tituscmd@users.noreply.github.com>
* Unify docker devcontainer with dockerfile used for CI (#1587)BloodStainedCrow2024-03-232-1/+56
| | | | | | | | | | | | | | | | | | | | * Only use one Dockerfile and build.sh script for both docker and devcontainer * Remove all now unneccessary tasks and scripts * Update to clang-format-14 * Move devcontainer.json into root folder * Fix conditional statements in Dockerfile * Move .devcontainer/README into doc/usingDevcontainers * Remove obsolete VSCode Task * Change standard compiler path to the correct compiler * Set GDB Path for debugging * Hide broken buttons from CMake Extension * Refactor .devcontainer * Remove unneccessary postBuildCommand * Add devcontainer dependencies to all docker images * Add Devcontainer Debug launch config * Add an additional c_cpp_properties config as a fallback for devcontainer * Remove obsolete Docker Argument * Fix wrong C/Cpp versions * Fix silent fail of gdb, add libncurses5
* Typo in example codeadumelie2024-03-141-1/+1
|
* More typos in code exampleadumelie2024-03-141-1/+1
|
* Typo in code exampleadumelie2024-03-141-1/+1
|
* Fix and update documentationadumelie2024-03-141-2/+2
| | | | Fixed missing colon typo in template for minimal app example Updated reference to Apps enum after file move
* bma421: Change acceleration values to 'binary milli-G' unitsGraham Jones2024-02-111-0/+2
| | | Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
* CMake watch faces selectionJean-François Milants2024-01-061-1/+1
| | | | | | Documentation : watch faces are not system apps anymore. Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
* CMake watch faces selectionJean-François Milants2024-01-061-12/+13
| | | | | | | Improve wording and replace "watchface" by "watch face" in Apps.md. Improve CMake readability regarding watch face selection Co-authored-by: Reinhold Gschweicher <pyro4hell@gmail.com>
* Watch face selection using CMakeJean-François Milants2024-01-061-4/+42
| | | | Update Apps.md to mention the selection of watchfaces using Cmake.
* Simple Weather Service : Fix timestampJean-François Milants2024-01-041-2/+2
| | | | | | Wording improvements in doc. Co-authored-by: Reinhold Gschweicher <pyro4hell@gmail.com>
* Simple Weather Service : Fix timestampJean-François Milants2024-01-041-2/+2
| | | | Mention that the timestamp should be expressed in localtime time.
* Simple Weather Service : Fix timestampJean-François Milants2024-01-041-2/+2
| | | | | In the documentation, specify that the timestamp is expressed in seconds from epoch (instead of nanoseconds). SimpleWeatherService now uses "localtime" (GetCurrentDateTime()) instead of UTC time.
* docs: Fix simple weather forecast message typeFintasticMan2024-01-031-2/+2
|
* User applications selection using CMakeJean-François Milants2023-12-231-1/+4
| | | | Fix typos in Apps.md and add new line in src/displayapp/apps/CMakeLists.txt
* Fix trailing space in doc/code/Apps.mdJF2023-12-231-1/+1
| | | Co-authored-by: NeroBurner <pyro4hell@gmail.com>
* Watch face selection at build timeJean-François Milants2023-12-231-14/+2
| | | | Replace the options that allowed to select the user apps independently by a single string variable that contains the ordered list of apps to build.
* CMake User Applications selectionJean-François Milants2023-12-231-1/+19
| | | | Update documentation about building a new application and add instructions to add the app in CMake files.
* Simple Weather ServiceJean-François Milants2023-12-231-1/+2
| | | | | Fix ToUInt64() in SimpleWeatherService.cpp. Fix typo in SimpleWeatherService.md.
* Simple Weather ServiceJean-François Milants2023-12-231-1/+1
| | | | Fix typo in doc/ble.md.
* Simple Weather ServiceJean-François Milants2023-12-231-21/+21
| | | | Store temperatures as int16_t (instead of uint8_t previously). The temperature is expressed in °C * 100.
* Simple Weather Service - code cleaning and improvementsJean-François Milants2023-12-231-3/+3
| | | | | | | Add missing icons (heavy clouds, thunderstorm, snow). Remove unneeded comparison operator (!=), improve conversion of Timestamp and MessageType, order includes. Fix typo in documentation. Remove not related change in StopWatch.
* SimpleWeather service : new weather implementationJean-François Milants2023-12-232-1/+72
| | | | | | | | | | This new implementation of the weather feature provides a new BLE API and a new weather service. The API uses a single characteristic that allows companion apps to write the weather conditions (current and forecast for the next 5 days). The SimpleWeather service exposes those data as std::optional fields. This new implementation replaces the previous WeahterService. The API is documented in docs/SimpleWeatherService.md.
* p8: Fix build when building for P8 variantsFintasticMan2023-12-161-1/+1
| | | | | | | Building with a TARGET_DEVICE set to any of the P8 variants' names caused the build to fail, because they contained hyphens. The build defines a macro `TARGET_DEVICE_$VARIANT`, which fails if `$VARIANT` contains a hyphen.
* Application selection at build time : update documentationJean-François Milants2023-11-191-30/+88
| | | | Update documentation about the apps (Apps.md) : fix obsolete information, add doc about user/system apps and update the part about the implementation of a new app.
* docs: Update Apps.md to remove Screen param (#1752)Alex E2023-11-161-2/+2
| | | | | This is needed since #1629. Co-authored-by: FintasticMan <finlay.neon.kid@gmail.com>
* lv_img_conv_py: minimal python port of node moduleReinhold Gschweicher2023-10-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Create a minimal python port of the node.js module `lv_img_conv`. Only the currently in use color formats `CF_INDEXED_1_BIT` and `CF_TRUE_COLOR_ALPHA` are implemented. Output only as binary with format `ARGB8565_RBSWAP`. This is enough to create the `resources-1.13.0.zip`. Python3 implements "propper" "banker's rounding" by rounding to the nearest even number. Javascript rounds to the nearest integer. To have the same output as the original JavaScript implementation add a custom rounding function, which does "school" rounding (to the nearest integer) Update CMake file in `resources` folder to call `lv_img_conf.py` instead of node module. For docker-files install `python3-pil` package for `lv_img_conv.py` script. And remove the `lv_img_conv` node installation. --- gen_img: special handling for python lv_img_conv script Not needed on Linux systems, as the shebang of the python script is read and used. But just to be sure use the python interpreter found by CMake. Also helps if tried to run on Windows host. --- doc: buildAndProgram: remove node script lv_img_conv mention Remove node script `lv_img_conv` mention and replace it for runtime-depency `python3-pil` of python script `lv_img_conv.py`.
* Corrects typo for make option for recovery-loaderSteve Amor2023-10-041-1/+1
|
* navigation: Move font to external memory (#1838)JF2023-09-021-1/+11
| | | | | | | | | | The TTF font used by the navigation app is ~20KB and is stored in internal flash memory. To free this space, the TTF font is now converted in 2 "atlas pictures" (pictures that contain multiple concatenated images) stored in the external flash memory. The navigation app now accesses one of those 2 files and apply an offset to display the desired picture. The corresponding documentation has also been updated. Add comments about the layout of the pictures that contain the icon and about the indexing of those icons. In documentation (buildAndProgram.md), edit the section about the debug compilation mode. Remove the part about removing the Navigation app to free some memory (since it's not relevant anymore) and explain how to selectively build parts of the firmware in Debug mode.
* Include repository initialization in docker build docsTailyFair2023-08-111-0/+10
|
* branches: Update files to refer to main instead of developFinlay Davidson2023-03-025-14/+12
|
* CONTRIBUTING: Move from doc to rootRiku Isokoski2023-02-201-61/+0
| | | | This is so the GitHub UI picks it up correctly.
* docs: Limit number of jobs used for compilationFinlay Davidson2023-02-191-2/+2
|
* Fix Link in buildWithVScodeTim Aschhoff2023-02-161-1/+1
|
* files-needed-by-factory: Adjust headersRiku Isokoski2023-02-131-2/+2
|
* files-needed-by-factory: Move to separate documentRiku Isokoski2023-02-132-38/+37
| | | | | These are instructions for maintainers, and should be in a separate document.
* contribute.md: Add commit format sectionRiku Isokoski2023-02-121-0/+14
| | | | | Inspired by: https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages
* contribute.md: Improve contributing instructionsRiku Isokoski2023-02-121-7/+26
| | | | | | | Denser instructions for absolute beginners. Links to GitHub docs. Add PR checklist and commit conventions sections based on the maintainer's guide.
* Fix Apps documentation DisplayApp method nameTailyFair2023-01-221-1/+1
|
* contribute.md: UpdateRiku Isokoski2023-01-221-6/+15
| | | | | Cleaned up the list of things you can help with. Added a few points
* doc: Add maintainer guideRiku Isokoski2023-01-221-0/+45
|
generated by cgit v1.2.3-70-g09d2 (git 2.51.2) at 2026-01-12 06:33:04 +0000