From b28ab21dde95756452e2cb40ee6f3d24638775c0 Mon Sep 17 00:00:00 2001 From: jdlugosz963 Date: Tue, 12 Dec 2023 17:05:41 +0100 Subject: Update README files. --- README.md | 125 ++++++++++++++++++++++++++++++++++--------------------------- README.org | 53 +++++++++++++++----------- 2 files changed, 100 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 981ad25..46dc7ab 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,71 @@ # Jak uruchomic projekt ? -- Android: - - Wymagania: - 1. Docker - - Kroki do wykonania na telefonie - 1. Wejdź do ustawień w telefonie i w zakładce \"Developer - options\" włącz opcję \"USB Debugging\" - 2. Podłącz telefon do komputera - - Kroki do wykonania na komputerze - 1. Przejść do projektu: - - ``` {.bash org-language="sh"} - cd cyberbadge_mobile - ``` - - 2. Sprawdzić czy urządzenie z androidem jest poprawnie - podłączone, możliwe będzie zaakceptowanie prośby o - podłączenie na telefonie. - - - **Note**: Jak będzie brakować uprawnień (u mnie było to - zbędne) można spróbować dodać regułkę do udeva, - dokładnie jest to opisanie tutaj: - - - ``` {.bash org-language="sh"} - ./dev-env adb devices - - # Poprawny output \/ - # * daemon not running; starting now at tcp:5037 - # * daemon started successfully - # List of devices attached - # 27141JEGR05136 device - ``` - - 3. Uruchomić projekt komenda podana poniżej: - - - **Note**: pierwsze uruchomienie będzie trwało długo (u - mnie to było kolo 30 minut). - - ``` {.bash org-language="sh"} - ./dev-env npm run start - ``` - - 4. Jak sie wszystko załaduję poprawnie powinna się ukazać ładna - grafika z napisem *Welcome to Metro*, w tym momencie należy - kliknąć literkę \"a\", aby uruchomić apkę na telefonie z - Androidem. - - 5. Jak się nic nie wysypie po drodze to apka powinna się - uruchomić sama na telefonie. - - 6. **NOTE**: Wszystkie operacje z **npm** powinny być - wykonywanie wewnątrz środowiska, czyli: - - ``` {.bash org-language="sh"} - ./dev-env npm [cokolwiek] - ``` +## Android: + +### Wymagania: + +1. Docker + +### Kroki do wykonania na telefonie + +1. Wejdź do ustawień w telefonie i w zakładce \"Developer options\" + włącz opcję \"USB Debugging\" +2. Podłącz telefon kablem do komputera + +### Kroki do wykonania na komputerze + +1. Przejść do projektu: + + ``` {.bash org-language="sh"} + cd cyberbadge_mobile + ``` + +2. Sprawdzić czy urządzenie z androidem jest poprawnie podłączone, + możliwe będzie zaakceptowanie prośby o podłączenie na telefonie. + + - **Note**: Jak będzie brakować uprawnień (u mnie było to zbędne) + można spróbować dodać regułkę do udeva, dokładnie jest to + opisanie tutaj: + + ``` {.bash org-language="sh"} + ./dev-env adb devices + + # Poprawny output \/ + # * daemon not running; starting now at tcp:5037 + # * daemon started successfully + # List of devices attached + # 27141JEGR05136 device + ``` + +3. Uruchomić projekt komendami podanymi poniżej: + + - **Note**: pierwsze uruchomienie będzie trwało długo (u mnie to + było kolo 30 minut). + + ``` {.bash org-language="sh"} + ./dev-env npm i + ./dev-env npm run start + ``` + +4. Jak sie wszystko załaduję poprawnie powinna się ukazać ładna grafika + z napisem *Welcome to Metro*, w tym momencie należy kliknąć literkę + \"a\", aby uruchomić apkę na telefonie z Androidem. + +5. Jak się nic nie wysypie po drodze to apka powinna się uruchomić sama + na telefonie. + +6. Dodatkowe info: + + - **NOTE**: Wszystkie operacje z **npm** powinny być wykonywanie + wewnątrz środowiska, czyli: + + ``` {.bash org-language="sh"} + ./dev-env npm [cokolwiek] + ``` + + - **NOTE** Aby uruchomić ponownie projekt, telefon powinien być + podłączony do komputera oraz wystarczy odpalić tę komendę. + + ``` {.bash org-language="sh"} + ./dev-env npm run start + ``` diff --git a/README.org b/README.org index 9b7b842..2663dff 100644 --- a/README.org +++ b/README.org @@ -1,15 +1,16 @@ #+TITLE: README * Jak uruchomic projekt ? -- Android: - + Wymagania: +** Android: +*** Wymagania: 1. Docker - + Kroki do wykonania na telefonie - 1. Wejdź do ustawień w telefonie i w zakładce "Developer options" włącz opcję "USB Debugging" - 2. Podłącz telefon do komputera +*** Kroki do wykonania na telefonie + 1. Wejdź do ustawień w telefonie i w zakładce "Developer options" + włącz opcję "USB Debugging" + 2. Podłącz telefon kablem do komputera - + Kroki do wykonania na komputerze +*** Kroki do wykonania na komputerze 1. Przejść do projektu: #+begin_src sh cd cyberbadge_mobile @@ -23,22 +24,23 @@ opisanie tutaj: https://reactnative.dev/docs/running-on-device - #+begin_src sh - ./dev-env adb devices + #+begin_src sh + ./dev-env adb devices - # Poprawny output \/ - # * daemon not running; starting now at tcp:5037 - # * daemon started successfully - # List of devices attached - # 27141JEGR05136 device - #+end_src + # Poprawny output \/ + # * daemon not running; starting now at tcp:5037 + # * daemon started successfully + # List of devices attached + # 27141JEGR05136 device + #+end_src - 3. Uruchomić projekt komenda podana poniżej: + 3. Uruchomić projekt komendami podanymi poniżej: - *Note*: pierwsze uruchomienie będzie trwało długo (u mnie to było kolo 30 minut). - #+begin_src sh - ./dev-env npm run start - #+end_src + #+begin_src sh + ./dev-env npm i + ./dev-env npm run start + #+end_src 4. Jak sie wszystko załaduję poprawnie powinna się ukazać ładna grafika z napisem /Welcome to Metro/, w tym momencie należy @@ -47,7 +49,14 @@ 5. Jak się nic nie wysypie po drodze to apka powinna się uruchomić sama na telefonie. - 6. *NOTE*: Wszystkie operacje z *npm* powinny być wykonywanie wewnątrz środowiska, czyli: - #+begin_src sh - ./dev-env npm [cokolwiek] - #+end_src + 6. Dodatkowe info: + - *NOTE*: Wszystkie operacje z *npm* powinny być wykonywanie wewnątrz środowiska, czyli: + #+begin_src sh + ./dev-env npm [cokolwiek] + #+end_src + + - *NOTE* Aby uruchomić ponownie projekt, telefon powinien być + podłączony do komputera oraz wystarczy odpalić tę komendę. + #+begin_src sh + ./dev-env npm run start + #+end_src -- cgit v1.2.3