https://github.com/devonfw/getting-started

devonfw getting started guide
https://github.com/devonfw/getting-started

Last synced: 10 months ago
JSON representation

devonfw getting started guide

• Host: GitHub
• URL: https://github.com/devonfw/getting-started
• Owner: devonfw
• Created: 2019-09-11T08:38:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-06-28T19:03:00.000Z (almost 4 years ago)
• Last Synced: 2025-03-15T14:14:04.712Z (about 1 year ago)
• Size: 11.2 MB
• Stars: 4
• Watchers: 18
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# devonfw Getting Started Guide

![devonfw logo](theme/images/devonfw-small.png "Welcome, new devonfw user!")

Welcome!

This getting-started guide is the entry-point for new **devonfw** users.\

You can work through it by either visiting the [wiki](https://github.com/devonfw/getting-started/wiki) tab here on GitHub or by downloading the [PDF](https://github.com/devonfw/getting-started/raw/develop/devonfw_getting_started.pdf).

Happy coding! :thumbsup:

---

## How to maintain this guide

Please follow these guidelines when maintaining the *getting-started* repository:

- Use links and references instead of duplicating content from other repositories!

- Always keep the contents of **_Sidebar.asciidoc** and **master-getting-started.asciidoc** in sync!

- In the **_Sidebar**:

  - link AsciiDoc pages located in this repo via `link:file-name.asciidoc[title]`\

  (Please make sure to include the _.asciidoc_ file extension here!)

  - link external pages via `https://online-url.domain#anchor[title]`

- In **master-getting-started**:

  - include AsciiDoc pages located in this repo via `include::file-name[leveloffset=2]`\

  (Please make sure to omit the _.asciidoc_ file extension here!)

  - reference AsciiDoc sections via `xref:section-title[title]`

  - reference AsciiDoc pages and top-level sections via `link:file-name#section-title[title]`\

  (Please note, that these links will **NOT** work in the GitHub wiki and standalone PDF, if the linked files are not located in this repo. They will however work on the devonfw website and in the complete devonfw-guide PDF, which is our priority.)

- Follow the general [docgen guidelines](https://github.com/devonfw/docgen/wiki#guidelines) and [asciidoc file guidelines](https://github.com/devonfw/devonfw-guide/issues/43)!

- To test your changes, build a local PDF using Maven:

  ```

  mvn clean package -Doutput.format=pdf

  ```