Skip to content

Commit

Permalink
prepare for release (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
icexin authored Jul 3, 2021
1 parent 9c84295 commit fd57a56
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
11 changes: 10 additions & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
on: [pull_request]
on: [push, pull_request]
name: CI
jobs:
ubuntu-latest:
Expand All @@ -25,6 +25,15 @@ jobs:
diff -u <(echo -n) <(gofmt -d $(find . -type f -name '*.go'))
mage -v iso
- name: Release
uses: softprops/action-gh-release@v1
if: startsWith(github.ref, 'refs/tags/')
with:
files: eggos.iso
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}


macos-latest:
runs-on: macos-latest
steps:
Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,29 @@ In general, writing kernel in Go is a very interesting experience. On the one ha
# Dependencies

- Go 1.13.x (only tested on Go1.13.x)
- i386-elf-gcc
- gcc
- qemu
- mage

## MacOS

``` bash
$ brew tap nativeos/i386-elf-toolchain
$ brew install i386-elf-binutils i386-elf-gcc i386-elf-gdb
$ go get github.com/magefile/mage
$ brew install x86_64-elf-binutils x86_64-elf-gcc x86_64-elf-gdb
$ brew install qemu
```

## Ubuntu

``` bash
$ go get github.com/magefile/mage
$ sudo apt-get install build-essential qemu
```

# Quickstart

``` bash
$ make
$ make qemu
$ mage qemu
```

# Debug
Expand All @@ -69,12 +70,12 @@ You can directly use the gdb command to debug, or use vscode for graphical debug
First you need to install gdb, if you are under macos, execute the following command

``` bash
brew install i386-elf-gdb
brew install x86_64-elf-gdb
```

Use the extension `Native Debug` in vscode to support debugging with gdb

First execute the `make qemu-debug` command to let qemu start the gdb server, and then use the debug function of vscode to start a debug session. The debug configuration file of vscode is built into the project.
First execute the `mage qemudebug` command to let qemu start the gdb server, and then use the debug function of vscode to start a debug session. The debug configuration file of vscode is built into the project.

Go provides simple support for gdb, see [Debugging Go Code with GDB](https://golang.org/doc/gdb) for details

Expand Down
2 changes: 1 addition & 1 deletion magefile.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var (
)

var (
GOTAGS = ""
GOTAGS = "nes"
)

var (
Expand Down

0 comments on commit fd57a56

Please sign in to comment.