Commit graph

180 commits

Author SHA1 Message Date
Riku Isokoski f4684f6ea5 CONTRIBUTING: Move from doc to root
This is so the GitHub UI picks it up correctly.
2023-02-20 22:27:10 +02:00
Finlay Davidson d968bcb1f3 docs: Limit number of jobs used for compilation 2023-02-19 20:26:08 +01:00
Tim Aschhoff 512ebf0704 Fix Link in buildWithVScode 2023-02-16 08:47:46 +02:00
Riku Isokoski 8e2dcda14f files-needed-by-factory: Adjust headers 2023-02-13 11:03:14 +02:00
Riku Isokoski dddca33d2f files-needed-by-factory: Move to separate document
These are instructions for maintainers, and should be in a separate
document.
2023-02-13 11:03:14 +02:00
Riku Isokoski 4e1a2aff47 contribute.md: Add commit format section
Inspired by:
https://www.klipper3d.org/CONTRIBUTING.html#format-of-commit-messages
2023-02-12 14:36:04 +02:00
Riku Isokoski f9d03cc396 contribute.md: Improve contributing instructions
Denser instructions for absolute beginners. Links to GitHub docs.

Add PR checklist and commit conventions sections based on the
maintainer's guide.
2023-02-12 14:36:04 +02:00
TailyFair 762d52e114 Fix Apps documentation DisplayApp method name 2023-01-22 09:08:06 +02:00
Riku Isokoski 4b75605412 contribute.md: Update
Cleaned up the list of things you can help with.
Added a few points
2023-01-22 09:02:47 +02:00
Riku Isokoski ee8349a676 doc: Add maintainer guide 2023-01-22 09:00:14 +02:00
John Paul Wohlscheid 2692231b95 minor grammar edits 2023-01-22 08:51:02 +02:00
tom-programming 361e381ac3 typo in the description
AMD64 and x86_64 are the same architecture - ARM64 should be specified instead
2022-12-06 12:06:57 +02:00
mashuptwice 957f7d2ec3 fixed filename 2022-10-10 12:43:11 +02:00
mashuptwice 668820ef5a Edit all occurences of "watchface" to "watch face" 2022-10-10 12:43:11 +02:00
Jean-François Milants 81ad89d6bc Add missing screenshot about the external resources support in Amazfish. 2022-10-05 21:07:11 +02:00
Jean-François Milants 60abbf0639 Add doc about external resources. 2022-10-02 12:27:10 +02:00
mashuptwice 809323df3a Applist is in ApplicationList.h 2022-09-17 21:29:48 +02:00
Jean-François Milants 6ed8e983e9 Remove CMake targets and corresponding CLI arguments that are specific to the debugging environment (USE_JLINK, USE_OPENOCD and USE_GDB_CLIENT). 2022-09-17 21:25:54 +02:00
Jean-François Milants c9a5c3fa5c Fix formatting. 2022-09-11 14:44:36 +02:00
Jean-François Milants cac9b3cc8e Add doc about the new parameter -DBUILD_RESOURCES. 2022-09-11 14:44:36 +02:00
Riku Isokoski c2b6a8de3e
Fix markdown format with autoformatter (#1284) 2022-08-21 14:50:09 +03:00
Riku Isokoski c495db8a71
Simplify coding style (#1280) 2022-08-21 14:44:05 +03:00
Riku Isokoski 093a66c8f8
Simplify contribute.md (#1281) 2022-08-21 14:43:56 +03:00
Riku Isokoski e02b58bf1b
Move all images to doc. Remove old images. (#1282) 2022-08-21 14:42:53 +03:00
Riku Isokoski 93477e25cf
Docs reorganization (#1236)
* Docs reorganization

Removed broken link

* README.md relative link consistency
2022-07-21 23:02:33 +03:00
Finlay Davidson 4482078d84 Downgrade GNU Arm Toolchain to 10.3-2021.10
This is because of this bug:
https://community.arm.com/support-forums/f/compilers-and-libraries-forum/52623/gcc-11-2-arm-none-eabi-internal-compiler-error-illegal-instruction
It is causing some of the GitHub Actions builds to fail.
2022-07-08 17:18:21 +02:00
Riku Isokoski c0770cde8a
Add InfiniTime Vision document (#1196) 2022-06-29 22:31:35 +03:00
Christoph Honal 8b0559c481 Add basic hardware configuration options for P8
This enables the configuration of the LFCLK source,
as well as the target hardware board pin configuration.
2022-06-27 08:28:48 +03:00
Finlay Davidson 373289c072 Be more specific about the compiler version 2022-06-11 22:59:38 +03:00
Finlay Davidson 350bca3965 Replace more instances of old gcc ver 2022-06-11 22:59:38 +03:00
Finlay Davidson 94cd2ba563 Update arm gcc toolchain to 11.2-2022.02
Updates the buildAndProgram doc and the docker
image, which means GitHub Actions will also use
the new toolchain.
2022-06-11 22:59:38 +03:00
kieranc 7e169ee4aa
Fix typo in gettingStarted guide (#1178) 2022-06-07 21:44:40 +03:00
Seth Itow 17079fb114 doc: Fix imageFile.png path in SWD.md 2022-06-06 21:20:13 +02:00
luz paz 20ac1cd374 revert portion of previous commit 2022-06-05 09:31:23 +03:00
luz paz 03a510bd18 Fix various typos
Found via `codespell -q 3 -S ./src/libs -L ans,doubleclick,trough`
2022-06-05 09:31:23 +03:00
Jean-François Milants dd313eb419 Docker container documentation : Fix typos, 1 line per sentence, remove obsolete paragraph, remove redundant 'image' parameter in the command to build the docker image, use ${PWD} instead of $(pwd). 2022-05-26 11:35:25 +02:00
Jean-François Milants 9b216bb16f Docker container documentation : Adapt the --user documentation according to the new behavior. 2022-05-26 11:35:25 +02:00
Jean-François Milants c77f923a33 Update links to the docker image with the new account : infinitime/infinitime-build. 2022-05-26 11:35:25 +02:00
Jean-François Milants 83b3a2a469 Small modernization with --platform parameter in docker readme 2022-05-26 11:35:25 +02:00
Jean-François Milants 831f93cd92 The main build workflow for GitHub Actions now uses the infinitime-build docker image to build the firmware. This allows to avoid the duplication of the build logic in Docker and Github workflow format.
The Dockerfile has been slightly adapted (remove the USER instructions). Docker images are now published in DockerHub (jf002/infinitime-build).
2022-05-26 11:35:25 +02:00
Yehoshua Pesach Wallach 34506be06e
comment about common error "glyphs.map" in old nodejs (#1142) 2022-05-18 16:14:58 +02:00
Reinhold Gschweicher 324927f2b7 update build stop, lv_font_conv not required globally installed 2022-05-16 11:59:44 +03:00
Yehoshua Pesach Wallach d967ed7d90 fontgen: move lv_font_conv doc 2022-05-10 22:20:02 +02:00
Riku Isokoski a9b77ae0d4 Alarm: Change checkable button for a switch 2022-02-12 18:36:11 +01:00
Eli Weiss ab059b9004 Revised documentation 2021-12-30 20:57:26 +01:00
Eli Weiss 97668c775b Improved "Getting Started" readability
Clarified ambiguous references, clarified phrasing
2021-12-30 20:57:26 +01:00
Eli Weiss 90352af626 Improved documentation readability
Improved documentation readability by rephrasing confusing sentences. Added Sitronix ST7789V datasheet link to SPI-LCD-driver.md for easier reference.
2021-12-30 20:57:26 +01:00
Eli Weiss c8214bc666 Update MemoryAnalysis.md
Cleaned up MemoryAnalysis.md for greater readability
2021-12-30 20:57:26 +01:00
Eli Weiss f66fcdd3ca Improved documentation readability
Removed extra space in contribute.md and cleaned up MemoryAnalysis.md phrasing and confusing punctuation.
2021-12-30 20:57:26 +01:00
Eli Weiss 1832a6c231 Update buildAndProgram.md
Improved documentation readability.
2021-12-30 20:57:26 +01:00