-## For manual gdb/gdbserver compilation instructions, have a look at the compilation.md file
+## TL;DR
-## Compiling gdb using docker
+- **Download**: Get the latest release from the [releases page](https://github.com/guyush1/gdb-static/releases/latest).
-This repository contains a dockerfile and build scripts to compile gdb and gdbserver statically for multiple architectures.
-Currently, the supported architectures are:
-- x86_64
-- arm
-- aarch64
-- powerpc (32bit)
-You can easily expand it to support more architectures by adding the appropriate cross compilers to the dockerfile, and other build scripts.
+## Introduction
-NOTE: You don't need to interact with the dockerfile directly, as the Makefile will take care of everything for you.
+Who doesn't love GDB? It's such a powerful tool, with such a great package.
+But sometimes, you run into one of these problems:
+- You can't install GDB on your machine
+- You can't install an updated version of GDB on your machine
+- Some other strange embedded reasons...
-### Building for a specific architecture
+This is where `gdb-static` comes in! We provide static builds of `gdb` (and `gdbserver` of course), so you can run them on any machine, without any dependencies!
+
+
+
+ Features
+
+
+- **Static Builds**: No dependencies, no installation, just download and run!
+- **Latest Versions**: We keep our builds up-to-date with the latest versions of GDB.
+- **Builtin Python (Optional)**: We provide builds with Python support built-in.
+- **XML Support**: Our builds come with XML support built-in, which is useful for some GDB commands.
+- **Wide Architecture Support**: We support a wide range of architectures:
+ - aarch64
+ - arm
+ - mips
+ - mipsel
+ - powerpc
+ - x86_64
+
+
+
+## Usage
+
+To get started with `gdb-static`, simply download the build for your architecture from the [releases page](https://github.com/guyush1/gdb-static/releases/latest), extract the archive, and copy the binary to your desired platform.
+
+> [!NOTE]
+> We provide two types of builds:
+> 1. Builds with Python support, which are approximately ~30 MB in size.
+> 2. Slimmer builds without Python support, which are approximately ~7 MB in size.
+
+You may choose to copy the `gdb` binary to the platform, or use `gdbserver` to debug remotely.
+
+## Development
+
+Alternatively, you can build `gdb-static` from source. To do so, follow the instructions below:
+
+
+
+Pre-requisites
+
+To be able to build `gdb-static`, you will need the following tools installed on your machine:
+
+###
+
+- Docker
+- Docker buildx
+- Git
+
+
+
+
+Building for a specific architecture
+
+
+To build `gdb-static` for a specific architecture, run the following command:
-To build for a specific architecture, you can use the following command:
```bash
-make build-
+make build[-with-python]-
```
-For example, to build for arm:
+Where `` is the architecture you want to build for, and `-with-python` may be added in order to compile gdb with Python support.
+
+The resulting binary will be placed in the `build/artifacts/` directory:
+
```bash
-make build-arm
-```
-
-The resulting binaries will be placed under the `build/artifacts/` directory.
-Each architecture will have its own directory under `build/artifacts/`. For example, the arm architecture will have the following directory structure:
-```
build/
- artifacts/
- arm/
- ...
+└── artifacts/
+ └── /
+ └── ...
```
-### Building for all architectures
+
+
+
+
+Building for all architectures
+
+
+To build `gdb-static` for all supported architectures, run the following command:
-To build for all architectures, you can use the following command:
```bash
make build
```
-### Cleaning the build
+The resulting binary will be placed in the `build/artifacts/` directory.
-To clean the build, you can use the following command:
-```bash
-make clean
-```
+
+
+
+## Contributing
+
+- Bug Report: If you see an error message or encounter an issue while using gdb-static, please create a [bug report](https://github.com/guyush1/gdb-static/issues/new?assignees=&labels=bug&title=%F0%9F%90%9B+Bug+Report%3A+).
+
+- Feature Request: If you have an idea or if there is a capability that is missing and would make `gdb-static` more robust, please submit a [feature request](https://github.com/guyush1/gdb-static/issues/new?assignees=&labels=enhancement&title=%F0%9F%9A%80+Feature+Request%3A+).
+
+## Contributors
+
+
+
+[//]: contributor-faces
+
+
+
+
+[//]: contributor-faces
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..267dc67
--- /dev/null
+++ b/package.json
@@ -0,0 +1,7 @@
+{
+ "name": "gdb-static",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/guyush1/gdb-static"
+ }
+}
\ No newline at end of file
+ 
+
+ 
+
+
+ 
+
+ 
+ 
+
+
+
+
+[//]: contributor-faces
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..267dc67
--- /dev/null
+++ b/package.json
@@ -0,0 +1,7 @@
+{
+ "name": "gdb-static",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/guyush1/gdb-static"
+ }
+}
\ No newline at end of file