From 84a2d70b51e0aef9299488732a45084e0d821ee5 Mon Sep 17 00:00:00 2001 From: Flipez Date: Sat, 12 Jun 2021 17:32:07 +0200 Subject: [PATCH 1/2] add readme Signed-off-by: Flipez --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2fbdf00 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# gb-link-firmware +## How to build +### Get the code +Clone the gb-link-firmware repo using `git clone https://github.com/stacksmashing/gb-link-firmware.git` and get a copy of the pico-sdk using `git clone https://github.com/raspberrypi/pico-sdk`. + +In order to include the tinyusb source make sure to run `git submodule update --init` inside `./pico-sdk`. + +### Set up the pico-sdk depedencies +For Ubuntu use + +`sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib` + +and make sure to check the [official repo](https://github.com/raspberrypi/pico-sdk) for changes. + +Then copy `./pico-sdk/external/pico_sdk_import.cmake` into `./gb-link-firmware/` and make sure to set `PICO_SDK_PATH` to the location of the pic-sdk folder. + +### Set up build folder +Inside `gb-link-firmware` create an `build` folder. If you made changes to the location of `pico-sdk`, the environment variable or similiar it is often easier to clean the content of this folder to make sure changes got pick up. + +### Actually compile something +Inside `gb-link-firmware` run both `cmake ..` and `make` in order to get your firmware build. + +If you made no changes to the make file the firmware should be generated as `gbusb.uf2`. \ No newline at end of file From 23ffd536f5c5d7f14880abdee2e544e55439b693 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20M=C3=BCller?= Date: Sun, 13 Jun 2021 17:03:45 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fbdf00..b90086b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ # gb-link-firmware +## Wiki +You can find all relevant information for the gb-link project in [the wiki](https://github.com/stacksmashing/gb-link-firmware/wiki) ## How to build ### Get the code Clone the gb-link-firmware repo using `git clone https://github.com/stacksmashing/gb-link-firmware.git` and get a copy of the pico-sdk using `git clone https://github.com/raspberrypi/pico-sdk`. @@ -20,4 +22,4 @@ Inside `gb-link-firmware` create an `build` folder. If you made changes to the l ### Actually compile something Inside `gb-link-firmware` run both `cmake ..` and `make` in order to get your firmware build. -If you made no changes to the make file the firmware should be generated as `gbusb.uf2`. \ No newline at end of file +If you made no changes to the make file the firmware should be generated as `gbusb.uf2`.