diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 556e444..e1b1514 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,7 +21,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 with: - path: example-application + path: LR-EnviroStation persist-credentials: false - name: Set up Python @@ -32,12 +32,12 @@ jobs: - name: Setup Zephyr project uses: zephyrproject-rtos/action-zephyr-setup@v1 with: - app-path: example-application + app-path: LR-EnviroStation toolchains: arm-zephyr-eabi ccache-cache-key: ${{ matrix.os }} - name: Build firmware - working-directory: example-application + working-directory: LR-EnviroStation shell: bash run: | if [ "${{ runner.os }}" = "Windows" ]; then @@ -46,7 +46,7 @@ jobs: west twister -T app -v --inline-logs --integration $EXTRA_TWISTER_FLAGS - name: Twister Tests - working-directory: example-application + working-directory: LR-EnviroStation shell: bash run: | if [ "${{ runner.os }}" = "Windows" ]; then diff --git a/README.md b/README.md index ceb2c51..254d8df 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Zephyr Example Application +# LR-EnviroStation - - + + - - + + Documentation @@ -13,41 +13,6 @@ API Documentation -This repository contains a Zephyr example application. The main purpose of this -repository is to serve as a reference on how to structure Zephyr-based -applications. Some of the features demonstrated in this example are: - -- Basic [Zephyr application][app_dev] skeleton -- [Zephyr workspace applications][workspace_app] -- [Zephyr modules][modules] -- [West T2 topology][west_t2] -- [Custom boards][board_porting] -- Custom [devicetree bindings][bindings] -- Out-of-tree [drivers][drivers] -- Out-of-tree libraries -- Example CI configuration (using GitHub Actions) -- Custom [west extension][west_ext] -- Custom [Zephyr runner][runner_ext] -- Doxygen and Sphinx documentation boilerplate - -This repository is versioned together with the [Zephyr main tree][zephyr]. This -means that every time that Zephyr is tagged, this repository is tagged as well -with the same version number, and the [manifest](west.yml) entry for `zephyr` -will point to the corresponding Zephyr tag. For example, the `example-application` -v2.6.0 will point to Zephyr v2.6.0. Note that the `main` branch always -points to the development branch of Zephyr, also `main`. - -[app_dev]: https://docs.zephyrproject.org/latest/develop/application/index.html -[workspace_app]: https://docs.zephyrproject.org/latest/develop/application/index.html#zephyr-workspace-app -[modules]: https://docs.zephyrproject.org/latest/develop/modules.html -[west_t2]: https://docs.zephyrproject.org/latest/develop/west/workspaces.html#west-t2 -[board_porting]: https://docs.zephyrproject.org/latest/guides/porting/board_porting.html -[bindings]: https://docs.zephyrproject.org/latest/guides/dts/bindings.html -[drivers]: https://docs.zephyrproject.org/latest/reference/drivers/index.html -[zephyr]: https://github.com/zephyrproject-rtos/zephyr -[west_ext]: https://docs.zephyrproject.org/latest/develop/west/extensions.html -[runner_ext]: https://docs.zephyrproject.org/latest/develop/modules.html#external-runners - ## Getting Started Before getting started, make sure you have a proper Zephyr development @@ -57,12 +22,12 @@ environment. Follow the official ### Initialization The first step is to initialize the workspace folder (``my-workspace``) where -the ``example-application`` and all Zephyr modules will be cloned. Run the following +the ``LR-EnviroStation`` and all Zephyr modules will be cloned. Run the following command: ```shell -# initialize my-workspace for the example-application (main branch) -west init -m https://github.com/zephyrproject-rtos/example-application --mr main my-workspace +# initialize my-workspace for the LR-EnviroStation (main branch) +west init -m https://git.dungeon.rip/Universe_Prison/LR-EnviroStation --mr main my-workspace # update Zephyr modules cd my-workspace west update @@ -73,7 +38,7 @@ west update To build the application, run the following command: ```shell -cd example-application +cd LR-EnviroStation west build -b $BOARD app ``` diff --git a/app/sample.yaml b/app/sample.yaml index 582bb8f..e343db9 100644 --- a/app/sample.yaml +++ b/app/sample.yaml @@ -2,8 +2,8 @@ # the Zephyr testing tool. In this file, multiple combinations can be specified, # so that you can easily test all of them locally or in CI. sample: - description: Example application - name: example-application + description: LR-EnviroStation + name: LR-EnviroStation common: build_only: true integration_platforms: diff --git a/boards/vendor/custom_plank/README.md b/boards/vendor/custom_plank/README.md index f4b868b..f3c2e53 100644 --- a/boards/vendor/custom_plank/README.md +++ b/boards/vendor/custom_plank/README.md @@ -2,5 +2,5 @@ `custom_plank` board is used to demonstrate how to create custom boards. It is in fact a simplified version of the nRF52840-DK board, so the -`example-application` can be run on that development kit when using +`LR-EnviroStation` can be run on that development kit when using `custom_plank`. diff --git a/doc/Doxyfile b/doc/Doxyfile index 86ae4bf..f5faf3e 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Example Application" +PROJECT_NAME = "LR-EnviroStation" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -54,7 +54,7 @@ PROJECT_NUMBER = 1.0.0 # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = A Zephyr-based example application +PROJECT_BRIEF = LR-EnviroStation # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 diff --git a/doc/_doxygen/main.md b/doc/_doxygen/main.md index 10402ea..7664cea 100644 --- a/doc/_doxygen/main.md +++ b/doc/_doxygen/main.md @@ -1,5 +1,5 @@ # Introduction -This is the Doxygen documentation for [example-application]. +This is the Doxygen documentation for [LR-EnviroStation]. -[example-application]: https://github.com/zephyrproject-rtos/example-application +[LR-EnviroStation]: https://git.dungeon.rip/Universe_Prison/LR-EnviroStation diff --git a/doc/conf.py b/doc/conf.py index e4d8bfb..e1ffa84 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -6,7 +6,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'Example Application' +project = 'LR-EnviroStation' copyright = '2024, The Zephyr Community' author = 'The Zephyr Community' release = '1.0.0' diff --git a/doc/index.rst b/doc/index.rst index 3890d83..0b4e979 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,7 +1,7 @@ -Welcome to Example Application's documentation! +Welcome to LR-EnviroStation's documentation! =============================================== -This is a simple Sphinx documentation setup for ``example-application``. +This is a simple Sphinx documentation setup for ``LR-EnviroStation``. .. toctree:: :maxdepth: 2 diff --git a/zephyr/module.yml b/zephyr/module.yml index 7d53dfd..aa753a1 100644 --- a/zephyr/module.yml +++ b/zephyr/module.yml @@ -3,7 +3,7 @@ build: # Path to the Kconfig file that will be sourced into Zephyr Kconfig tree under - # Zephyr > Modules > example-application. Path is relative from root of this + # Zephyr > Modules > LR-EnviroStation. Path is relative from root of this # repository. kconfig: Kconfig # Path to the folder that contains the CMakeLists.txt file to be included by