From b329cf5e2ab8935e972a3eac05f41ec3a38491ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Allan=20Nordh=C3=B8y?= Date: Thu, 30 Sep 2021 05:19:57 +0200 Subject: [PATCH 1/2] Getting Started documentation reworked --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5eae8a5..aafb542 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,35 @@ --- -description: All about creating and distributing apps for elementary OS +description: Creating and distributing apps for elementary OS --- # Getting Started -## What We Will \(And Won't\) Cover +## What is \(and Isn't\) Covered -We're going to assume that you have absolutely no experience in writing apps for elementary OS. But we will assume some basic programming knowledge, and hopefully a little experience in Vala or at least similarly syntaxed languages. If you're not familiar with Vala, we highly encourage you to brush up on it before coming here. There are great resources \(text and video\) available for learning Vala on [Valadoc.org](https://valadoc.org/). +No experience in writing apps for elementary OS is assumed, but basic programming knowledge is. +A little experience, prior [knowledge of Vala](https://valadoc.org/) (or at least similarly syntaxed languages) is valuable. -We’re also not covering design too much in this guide; that’s what the [Human Interface Guidelines \(HIG\)](https://docs.elementary.io/hig/) are for, and you’re highly encouraged to take a look there before beginning your app. We're going to assume you have a basic knowledge of \(or at least a quick link to\) the HIG and focus on coding. However, elementary OS is all about great design and stellar consistency. It’s important you grasp these concepts before moving on. +Design is covered in [Human Interface Guidelines \(HIG\)](https://docs.elementary.io/hig/). +By adhering to it you can match the great design and stellar consistency of elementary OS. ## Writing Apps -In this book, we're going to talk about building apps using GTK, Granite, and other tech available in elementary OS, setting up a build system, hosting your code for collaborative development, working with translations, a few other bits and pieces, and finally packaging and distributing your new app. +This book details +building apps using GTK, Granite, and other technology available in elementary OS, +setting up a build system, +hosting your code for collaborative development, +working with translations, +a few other bits and pieces, +and finally packaging and distributing your new app. -Some of you may feel confident enough to jump straight into coding. If that's the case, you might want to skip ahead and start writing your first app. - -However, we strongly recommend to at least skim through the preparation step. Having the right setup is going to help you reach your goals faster, and having a solid foundation is going to help you throughout the rest of this book. +Skip ahead and start writing your first app if confident enough to jump straight into coding, +but do skim through the preparation step first. +Having the right setup helps in reaching your goals faster, +and a solid foundation comes in handy throughout the rest of this book. ## AppCenter Publishing Requirements -There are also a number of technical, metadata, legal, and other requirements for publishing your app to users via AppCenter. +Correct metadata, legal specificaion, and other technical aspects are required to publish your app to users on AppCenter. {% page-ref page="appcenter/publishing-requirements.md" %} From c2ec86ea6f63c8117b539cf175fd12b5787242db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Danielle=20For=C3=A9?= Date: Fri, 10 Dec 2021 15:04:18 -0800 Subject: [PATCH 2/2] Update README.md --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index aafb542..7f70289 100644 --- a/README.md +++ b/README.md @@ -6,30 +6,31 @@ description: Creating and distributing apps for elementary OS ## What is \(and Isn't\) Covered -No experience in writing apps for elementary OS is assumed, but basic programming knowledge is. -A little experience, prior [knowledge of Vala](https://valadoc.org/) (or at least similarly syntaxed languages) is valuable. +No experience in writing apps for elementary OS is assumed, but basic programming knowledge is. A little experience with Vala (or at least similarly syntaxed languages) will be valuable. If you're not familiar with Vala, there are great resources (text and video) available for learning Vala on [Valadoc.org](https://valadoc.org/). -Design is covered in [Human Interface Guidelines \(HIG\)](https://docs.elementary.io/hig/). -By adhering to it you can match the great design and stellar consistency of elementary OS. +Design is covered in the [Human Interface Guidelines \(HIG\)](https://docs.elementary.io/hig/). We reference the HIG throughout this guide and it's important you grasp the concepts proposed there, but this guide is focused primarily on code. ## Writing Apps -This book details -building apps using GTK, Granite, and other technology available in elementary OS, -setting up a build system, -hosting your code for collaborative development, -working with translations, -a few other bits and pieces, -and finally packaging and distributing your new app. +This guide details: +* Building apps using GTK, Granite, and other technology available in elementary OS +* Setting up a build system +* Hosting your code for collaborative development +* Working with translations +* Packaging and distributing your new app on AppCenter +* Working with Platform APIs -Skip ahead and start writing your first app if confident enough to jump straight into coding, -but do skim through the preparation step first. -Having the right setup helps in reaching your goals faster, -and a solid foundation comes in handy throughout the rest of this book. +You may feel confident enough to jump straight into writing your first appp: + +{% page-ref page="appcenter/our-first-app.md" %} + +However, we strongly recommend to at least skim "The Basic Setup" first. Having the right setup is going to help you reach your goals faster, and a solid foundation is going to help you throughout the rest of this book. + +{% page-ref page="appcenter/the-basic-setup.md" %} ## AppCenter Publishing Requirements -Correct metadata, legal specificaion, and other technical aspects are required to publish your app to users on AppCenter. +There are also a number of technical, metadata, legal, and other requirements for publishing your app to users via AppCenter. {% page-ref page="appcenter/publishing-requirements.md" %}