git.y1.nz

commit 8d79fc6949a03ca05cad62f36acbe2f8701e98dd
parent 92436b9b7492d3d367a2b82323960d6751ac322c
Author: bbbbbr <reg+github@roughhousing.com>
Date:   Fri, 23 Jul 2021 23:08:25 -0700

Docs: Getting Started: Add first step - download the release and unzip it
Diffstat:
M
docs/pages/01_getting_started.md
21
++++++++++++---------

1 file changed, 12 insertions(+), 9 deletions(-)
diff --git a/docs/pages/01_getting_started.md b/docs/pages/01_getting_started.md
@@ -3,8 +3,11 @@
 
 Follow the steps in this section to start using GBDK-2020.
 
+# 1. Download a Release and unzip it
+You can get the latest releases from here: https://github.com/gbdk-2020/gbdk-2020/releases
 
-# 1. Compile Example projects
+
+# 2. Compile Example projects
 Make sure your GBDK-2020 installation is working correctly by compiling some of the included @ref docs_example_programs "example projects".
 
 Navigate to the example projects folder (`"examples/gb/"` under your GBDK-2020 install folder) and open a command line. Then type:
@@ -16,7 +19,7 @@ This should build all of the examples sequentially. You can also navigate into a
 If everything works and there are no errors reported each example sub-folder should have it's on .gb ROM file.
 
 
-# 2. Use a Template
+# 3. Use a Template
 __To create a new project use a template!__ 
 
 There are template projects included in the @ref docs_example_programs "GBDK example projects" to help you get up and running. Their folder names start with `template_`.
@@ -30,17 +33,17 @@ There are template projects included in the @ref docs_example_programs "GBDK exa
 4. Open main.c to start making changes.
 
 
-# 3. If you use GBTD / GBMB, get the fixed version
+# 4. If you use GBTD / GBMB, get the fixed version
 If you plan to use GBTD / GBMB for making graphics, make sure to get the version with the `const` fix and other improvements. See @ref const_gbtd_gbmb.
 
 
-# 4. Review Coding Guidelines
+# 5. Review Coding Guidelines
 Take a look at the @ref docs_coding_guidelines "coding guidelines", even if you have experience writing software for other platforms. There is important information to help you get good results and performance on the Game Boy.
 
 If you haven't written programs in C before, check the @ref docs_c_tutorials "C tutorials section".
 
 
-# 5. Hardware and Resources
+# 6. Hardware and Resources
 If you have a specific project in mind, consider what hardware want to target. It isn't something that has to be decided up front, but it can influence design and implementation.
 
 What size will your game or program be?
@@ -55,21 +58,21 @@ What hardware will it run on?
   - See how to @ref faq_gb_type_header_setting "set the compatibility type in the cartridge header". Read more about hardware differences in the @ref Pandocs
 
 
-# 6. Set up C Source debugging
+# 7. Set up C Source debugging
 Tracking down problems in code is easier with a debugger. Emulicious has a @ref Emulicious_debug "debug adapter" that provides C source debugging with GBDK-2020.
 
 
-# 7. Try a GBDK Tutorial
+# 8. Try a GBDK Tutorial
 You might want to start off with a guided GBDK tutorial from the @ref links_gbdk_tutorials "GBDK Tutorials section".
 
   - __Note:__ Tutorials (or parts of them) may be based on the older GBDK from the 2000's before it was updated to be GBDK-2020. The general principals are all the same, but the setup and parts of the @ref docs_toolchain "toolchain" (compiler/etc) may be somewhat different and some links may be outdated (pointing to the old GBDK or old tools).
 
 
-# 8. Read up!
+# 9. Read up!
 - It is strongly encouraged to read more @ref docs_index "GBDK-2020 General Documentation".
 - Learn about the Game Boy hardware by reading through the @ref Pandocs technical reference.
 
 
-# 9. Need help?
+# 10. Need help?
 Check out the links for @ref links_help_and_community "online community and support" and read the @ref docs_faq "FAQ".
 

This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.