summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorOskar Nyberg <oskar@mullvad.net>2020-12-15 11:34:16 +0100
committerOskar Nyberg <oskar@mullvad.net>2020-12-15 11:34:16 +0100
commitc9994fc0348b9b2c36df6945fc31983af94f7f93 (patch)
treef5716a5872127451f0334ede60f0f843a339725e
parent5329f5a02913ea67f63e53e3eb45a846907bd081 (diff)
parent67d63601e10c8aba99bae71778682df37c1442a0 (diff)
downloadmullvadvpn-c9994fc0348b9b2c36df6945fc31983af94f7f93.tar.xz
mullvadvpn-c9994fc0348b9b2c36df6945fc31983af94f7f93.zip
Merge branch 'update-readme-gui-structure'
-rw-r--r--README.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/README.md b/README.md
index d221784bfa..da7316bff9 100644
--- a/README.md
+++ b/README.md
@@ -483,19 +483,19 @@ If you're using GNOME, try installing one of these GNOME Shell extensions:
## Repository structure
### Electron GUI app and electron-builder packaging assets
-- **gui/packages/**
- - **components/** - Platform agnostic shared react components
- - **desktop/** - The desktop implementation
- - **assets/** - graphical assets and stylesheets
- - **src/**
- - **main/**
- - **index.ts** - entry file for the main process
- - **renderer/**
- - **app.ts** - entry file for the renderer process
- - **routes.ts** - routes configurator
- - **transitions.ts** - transition rules between views
- - **config.json** - App color definitions and URLs to external resources
- - **test/** - Electron GUI tests
+- **gui/**
+ - **assets/** - Graphical assets and stylesheets
+ - **src/**
+ - **main/**
+ - **index.ts** - Entry file for the main process
+ - **renderer/**
+ - **app.tsx** - Entry file for the renderer process
+ - **routes.tsx** - Routes configurator
+ - **transitions.ts** - Transition rules between views
+ - **config.json** - App color definitions and URLs to external resources
+ - **tasks/** - Gulp tasks used to build app and watch for changes during development
+ - **distribution.js** - Configuration for `electron-builder`
+ - **test/** - Electron GUI tests
- **dist-assets/** - Icons, binaries and other files used when creating the distributables
- **binaries/** - Git submodule containing binaries bundled with the app. For example the
statically linked OpenVPN binary. See the README in the submodule for details