From 5278b16cec7c2ba0c088846be91727846997d79d Mon Sep 17 00:00:00 2001 From: simon Date: Wed, 4 Dec 2024 16:53:49 +0100 Subject: [PATCH 1/4] adding installation method for mac via pipenv --- .../software/nk-app2/installation_mac.rst | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 source/components/software/nk-app2/installation_mac.rst diff --git a/source/components/software/nk-app2/installation_mac.rst b/source/components/software/nk-app2/installation_mac.rst new file mode 100644 index 0000000000..392a9472df --- /dev/null +++ b/source/components/software/nk-app2/installation_mac.rst @@ -0,0 +1,20 @@ +Mac Install +============= + +Pipenv +----------------- + +This is the simplest way for now to install the Nitrokey App 2 on Mac. Further methods are being worked on. + +0. `Install `__ Pipenv if it is not already installed. +1. Create a work directory ``mkdir nitrokeyapp`` +2. Enter the directory ``cd nitrokeyapp`` +3. Install the app via pipenv ``pipenv install nitrokeyapp`` + +The app cam be updated the following way + +1. Enter the work directory ``cd nitrokeyapp`` +2. pipenv update + +To start the app run enter the workdirectory ``cd nitrokeyapp`` and run ``pipenv run nitrokeyapp`` + From d89fd983541104db35b46f65f45a77d19df85139 Mon Sep 17 00:00:00 2001 From: simon Date: Wed, 11 Dec 2024 16:20:05 +0100 Subject: [PATCH 2/4] using correct length line and fixes wording --- source/components/software/nk-app2/installation_mac.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/components/software/nk-app2/installation_mac.rst b/source/components/software/nk-app2/installation_mac.rst index 392a9472df..0fae5503fb 100644 --- a/source/components/software/nk-app2/installation_mac.rst +++ b/source/components/software/nk-app2/installation_mac.rst @@ -1,8 +1,8 @@ Mac Install -============= +=========== Pipenv ------------------ +------ This is the simplest way for now to install the Nitrokey App 2 on Mac. Further methods are being worked on. @@ -16,5 +16,4 @@ The app cam be updated the following way 1. Enter the work directory ``cd nitrokeyapp`` 2. pipenv update -To start the app run enter the workdirectory ``cd nitrokeyapp`` and run ``pipenv run nitrokeyapp`` - +To run the application, go into the workdirectory ``cd nitrokeyapp`` and run ``pipenv run nitrokeyapp``. From 25f093acacf70a7a6683d670dce50b307df49872 Mon Sep 17 00:00:00 2001 From: simon Date: Wed, 11 Dec 2024 16:20:05 +0100 Subject: [PATCH 3/4] fixing line break, counting and wording --- source/components/software/nk-app2/installation_mac.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/components/software/nk-app2/installation_mac.rst b/source/components/software/nk-app2/installation_mac.rst index 0fae5503fb..5072e3490b 100644 --- a/source/components/software/nk-app2/installation_mac.rst +++ b/source/components/software/nk-app2/installation_mac.rst @@ -6,10 +6,10 @@ Pipenv This is the simplest way for now to install the Nitrokey App 2 on Mac. Further methods are being worked on. -0. `Install `__ Pipenv if it is not already installed. -1. Create a work directory ``mkdir nitrokeyapp`` -2. Enter the directory ``cd nitrokeyapp`` -3. Install the app via pipenv ``pipenv install nitrokeyapp`` +1. `Install `__ Pipenv if it is not already installed. +2. Create a work directory ``mkdir nitrokeyapp`` +3. Enter the directory ``cd nitrokeyapp`` +4. Install the app via pipenv ``pipenv install nitrokeyapp`` The app cam be updated the following way From a78026cce1dd21cb411c86bb15784b03078fb745 Mon Sep 17 00:00:00 2001 From: simon Date: Mon, 6 Jan 2025 15:34:07 +0100 Subject: [PATCH 4/4] added code blocks and fixed typos --- .../software/nk-app2/installation_mac.rst | 32 +++++++++++++++---- 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/source/components/software/nk-app2/installation_mac.rst b/source/components/software/nk-app2/installation_mac.rst index 5072e3490b..ea7933cd13 100644 --- a/source/components/software/nk-app2/installation_mac.rst +++ b/source/components/software/nk-app2/installation_mac.rst @@ -7,13 +7,33 @@ Pipenv This is the simplest way for now to install the Nitrokey App 2 on Mac. Further methods are being worked on. 1. `Install `__ Pipenv if it is not already installed. -2. Create a work directory ``mkdir nitrokeyapp`` -3. Enter the directory ``cd nitrokeyapp`` -4. Install the app via pipenv ``pipenv install nitrokeyapp`` +2. Create a work directory -The app cam be updated the following way +:: -1. Enter the work directory ``cd nitrokeyapp`` + mkdir nitrokeyapp + +3. Enter the directory +:: + + cd nitrokeyapp +4. Install the app via pipenv +:: + + pipenv install nitrokeyapp + +The app can be updated the following way + +1. Enter the work directory +:: + + cd nitrokeyapp 2. pipenv update -To run the application, go into the workdirectory ``cd nitrokeyapp`` and run ``pipenv run nitrokeyapp``. +To run the application, go into the workdirectory +:: + + cd nitrokeyapp and run +:: + + pipenv run nitrokeyapp.