Fix installation description for Apple Silicon #2955 (#2956)

* Fix installation description for Apple Silicon #2955 * Modified changelog * Added this change * Update README.md Co-authored-by: Ruben Bridgewater <[email protected]> Co-authored-by: Leon Ochmann <[email protected]> Co-authored-by: Jan N. Rückert <[email protected]> Co-authored-by: Ruben Bridgewater <[email protected]>
MaibornWolff · Aug 9, 2022 · 284ba3c · 284ba3c
1 parent 2093f11
commit 284ba3c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ### Fixed 🐞
 
+-   Fix installation instructions for Apple Silicon [#2956](https://github.com/MaibornWolff/codecharta/pull/2956)
 -   Fix release tag [#2954](https://github.com/MaibornWolff/codecharta/pull/2954)
 -   Prevent dark map on unhover [#2959](https://github.com/MaibornWolff/codecharta/pull/2959)
 -   Zoom in/out time [#2959](https://github.com/MaibornWolff/codecharta/pull/2959)

diff --git a/README.md b/README.md
@@ -58,22 +58,8 @@
 
 ### How to use **Visualization**?
 
--   **Online:** You can try the [web visualization](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json.gz&file=codecharta_analysis.cc.json.gz) without any installation and explore the CodeCharta code (shown by default).
--   **Local:**
-    -   _Standalone:_ You can find different versions (MacOS, Linux, Windows, Web) for CC on the [release](https://github.com/MaibornWolff/codecharta/releases) page (you don't need internet to run them).
-    -   _Dev:_ To clone and run this application, you'll need [Git](https://git-scm.com)
-        and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed.
-        From your command line run:
-
-```bash
-# Clone the CodeCharta repo
-$ git clone https://github.com/MaibornWolff/codecharta.git
-# Navigate to Visualization
-$ cd visualization
-# Run the development server
-$ npm run dev
-# Upload any .cc.json!
-```
+-   **Online:** You can try the [web visualization](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json&file=codecharta_analysis.cc.json) without any installation and explore the CodeCharta code (shown by default).
+-   **Local:** See [here](visualization/README.md).
 
 ### How to use **Analysis**?
 

diff --git a/visualization/README.md b/visualization/README.md
@@ -27,8 +27,19 @@ Change working directory `cd <projectpath>/codecharta/visualization/`
 
 #### Install project for development
 
--   Install node >= 8
--   Install dependencies `npm install`.
+To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed. From your command line run:
+
+```bash
+# Clone the CodeCharta repo
+$ git clone https://github.com/MaibornWolff/codecharta.git
+# Navigate to Visualization
+$ cd codecharta/visualization
+# Installation. If you're on Apple Silicon, you have to do `npm_config_nwjs_process_arch=x64 npm install` instead (see https://github.com/nwjs/npm-installer/issues/83).
+$ npm install
+# Run the development server
+$ npm run dev
+# Upload any .cc.json!
+```
 
 Once you have installed the project, you can use all tasks described in the next section.