Skip to content

Commit

Permalink
Expand Getting Started section by default. Minor docs changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
wnayes committed Dec 29, 2023
1 parent cae3854 commit 7d42398
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"label": "Setup",
"label": "Getting Started",
"position": 2,
"collapsed": false,
"link": {
"type": "generated-index",
"description": "Steps to get started with electron-wm."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,22 @@ What does this script do?
- The default is `$XDG_CONFIG_HOME/electron-wm-config/`, which is typically `~/.config/electron-wm-config/`
- It prompts you for a template to base your configuration from.
- The only template available currently is `react`.
- It performs a `git clone` of your chosen template into the folder you chose.
- It performs a `git clone` of the template into the folder chosen earlier.
- For the `react` template, you get a local clone of
`https://github.com/wnayes/electron-wm/tree/react-config-release`

At this point, you have a local git repository that configures electron-wm.
You'll want to [get the window manager running](./running), but you're
otherwise free to start making tweaks inside the configuration.

Be sure to perform an `npm install` within the configuration folder to
set up dependencies, and repeat any time after you make package.json changes.

```
cd ~/.config/electron-wm-config
npm install
```

## Optional Git Branch Setup

The working copy in the cloned repository branch is going to be compatible with
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 3
After installation and configuration, you can run the window manager and try it
out.

As with other X11 window managers, you probably want to edit your `.xinitrc`
As with other X11 window managers, it is common to edit your `.xinitrc`
file and add `electron-wm` to the end, making it the last executable invoked
when starting your X server.

Expand All @@ -19,7 +19,7 @@ electron-wm --config ~/my-desktop-config
```

If you omit `--config` it is assumed that your configuration resides in the
default `electron-wm-config` folder that the init script creates.
`electron-wm-config` folder that the init script creates by default.

Note that `--config` doesn't have to refer to a local folder. This can be any
"package identifier" that Node.js can `require` at runtime, provided you have
Expand Down

0 comments on commit 7d42398

Please sign in to comment.