Skip to content
This repository has been archived by the owner on Aug 5, 2024. It is now read-only.

Commit

Permalink
Merge pull request #1 from CornetPanique86/main
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
OrigamingWasTaken authored Feb 21, 2024
2 parents 9db965c + 2c3f43b commit edc0055
Showing 1 changed file with 68 additions and 2 deletions.
70 changes: 68 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You can download the app from the [nightly builds](https://nightly.link/Communau

## Building

(Note: If you're on Windows, you must install WSL)
(Note: If you're on Windows, you must install WSL: [see guide below](https://github.com/Communaute-Events/AutoEvent#windows))

Install Jq
```shell
Expand Down Expand Up @@ -82,4 +82,70 @@ Run the build script for your target OS
./build win
# All platforms
./build all
```
```

### Windows

#### Install WSL

To install WSL, or Windows Subsystem for Linux, open Powershell/Command prompt in **administrator** mode and enter the command:
```shell
wsl --install
```
###### [*[more info]*](https://learn.microsoft.com/en-us/windows/wsl/install)

Now, open an Ubuntu console which will request you to create your user account.

Before going further, update the packages and add wget (retrieve content from web servers) and ca-certificates (allow SSL-based applications to check for the authenticity of SSL connections):
```shell
sudo apt update && sudo apt upgrade
sudo apt-get install wget ca-certificates
```
###### [*[more info]*](https://learn.microsoft.com/en-us/windows/wsl/setup/environment#set-up-your-linux-username-and-password)

#### VS Code Development Environment
Install the [Remote Development extension pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) which includes the WSL extension (or only install the [WSL extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)).

To open a WSL project:
- **from the command line**: open the Ubuntu console, type `code .`
- **from VS Code**: type `WSL` in the command palette (`Ctrl+Shift+P`) to see available options.

#### Install Node.js
The most stable way is to use [NVM](https://github.com/nvm-sh/nvm), or Node Version Manager.

Install NVM:
```shell
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
```

Now restart WSL or type the following command:
```shell
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
```

If it's installed:
```shell
$ nvm --version # returns version
$ nvm ls
iojs -> N/A (default)
node -> stable (-> N/A) (default)
unstable -> N/A (default)
```

Now install the LTS versions of Node.js:
```shell
nvm install --lts
```

...if it's installed:
```shell
node --version
npm --version
```

[*[more info]*](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl)



Now you can install Jq, the neu-cli and clone the repo using the commands stated [above](https://github.com/Communaute-Events/AutoEvent#building).

0 comments on commit edc0055

Please sign in to comment.