improve README formatting (#975)

This commit is contained in:
Ethan Arnold 2021-05-05 23:50:23 +02:00 committed by GitHub
parent 8ca9402d11
commit 6cc84b69ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 3 deletions

View File

@ -1,10 +1,12 @@
Docker running example Docker running example
=========================================== ===========================================
* Build Image * Build Image
$ docker-compose build
`$ docker-compose build`
* Development * Development
$ docker-compose run dev
`$ docker-compose run dev`
* Runtime * Runtime
``` ```
@ -50,39 +52,61 @@ For OpenSUSE Build Service Release
=========================================== ===========================================
* Build Package * Build Package
```
$ ./build-aux/git-version-gen . > .tarball-version $ ./build-aux/git-version-gen . > .tarball-version
$ dpkg-source -b . $ dpkg-source -b .
$ rm -f .tarball-version $ rm -f .tarball-version
```
* Get Release Key * Get Release Key
```
$ wget http://download.opensuse.org/repositories/home:/acetcom:/open5gs:/latest/xUbuntu_18.04/Release.key $ wget http://download.opensuse.org/repositories/home:/acetcom:/open5gs:/latest/xUbuntu_18.04/Release.key
$ sudo apt-key add Release.key $ sudo apt-key add Release.key
```
* Setup Repository * Setup Repository
```
$ sudo sh -c "echo 'deb https://download.opensuse.org/repositories/home:/acetcom:/open5gs:/latest/xUbuntu_18.04/ ./' > /etc/apt/sources.list.d/open5gs-latest.list" $ sudo sh -c "echo 'deb https://download.opensuse.org/repositories/home:/acetcom:/open5gs:/latest/xUbuntu_18.04/ ./' > /etc/apt/sources.list.d/open5gs-latest.list"
$ sudo apt-get update $ sudo apt-get update
```
For Launchpad Release For Launchpad Release
=========================================== ===========================================
* Run Docker * Run Docker
```
$ docker-compose run dev $ docker-compose run dev
```
* Setup Debian Environment * Setup Debian Environment
```
export DEBFULLNAME='Sukchan Lee' export DEBFULLNAME='Sukchan Lee'
export DEBEMAIL='acetcom@gmail.com' export DEBEMAIL='acetcom@gmail.com'
```
* Transfer GPG key * Transfer GPG key
```
$ gpg --export-secret-keys --armor --output private.asc $ gpg --export-secret-keys --armor --output private.asc
$ gpg --import private.asc $ gpg --import private.asc
$ gpg --export > public.asc $ gpg --export > public.asc
$ gpg --import public.asc $ gpg --import public.asc
```
* Version Change * Version Change
```
$ vi meson.build $ vi meson.build
$ ./misc/git-version-gen . > .tarball-version 2>/dev/null $ ./misc/git-version-gen . > .tarball-version 2>/dev/null
```
* Upload OpenBuildService * Upload OpenBuildService
```
$ dch -i $ dch -i
$ meson subprojects download freeDiameter $ meson subprojects download freeDiameter
$ debuild -S -uc -us -d $ debuild -S -uc -us -d
@ -90,16 +114,25 @@ export DEBEMAIL='acetcom@gmail.com'
$ cd home\:acetcom\:open5gs/latest/ $ cd home\:acetcom\:open5gs/latest/
$ cp ~/git/open5gs_1.0.0.* . $ cp ~/git/open5gs_1.0.0.* .
$ osc ci -m "Update it" $ osc ci -m "Update it"
```
* Upload LaunchPad * Upload LaunchPad
```
$ dch -i $ dch -i
$ meson subprojects download freeDiameter $ meson subprojects download freeDiameter
$ debuild -S -d $ debuild -S -d
$ dput ppa:open5gs/latest *.source.changes $ dput ppa:open5gs/latest *.source.changes
```
* Tagging * Tagging
```
$ git tag v1.x.x -a $ git tag v1.x.x -a
```
* Build package * Build package
```
$ dpkg-buildpackage -d $ dpkg-buildpackage -d
```