Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukylix committed Nov 12, 2023
1 parent 218279b commit 3edaf7c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Visit the [release page](https://github.com/Lukylix/Chrolog/releases) to downloa

# How to Run on Linux

To run Chrolog on Linux, launch it from a terminal
(Without launching from a terminal, the necessary sudo prompt will not function correctly).
To run Chrolog on Linux, launch it from a terminal.
Without launching from a terminal, the necessary sudo prompt will not function correctly.

# Development Guidelines

Expand All @@ -31,6 +31,7 @@ Type these commands in your terminal:

```bash
npm install
npm run m-postinstall
npm run dev
```

Expand All @@ -44,18 +45,32 @@ Ensure that you have the Build Tools for [Microsoft Visual Studio 2022](https://
if you want to recompile the cpp files install [gcc](https://code.visualstudio.com/docs/cpp/config-mingw#_prerequisites) for Visual Studio code.

In Visual Studio Code :
`ctrl`+`shift`+`B` To run the chrolog.dll build
`ctrl`+`shift`+`B` To run the chrolog.dll build (build-lib-win).
or
Execute command -> Task: run task -> build-lib
Execute command -> Task: run task -> build-lib-win

Then build the electron app.

```bash
npm run m-postinstall
npm run build:win
```

#### For linux

Ensure that you have the build-essential to compile the lib and the input server.

```bash
sudo apt-get update
sudo apt-get install build-essential
```

In Visual Studio Code :
`ctrl`+`shift`+`B` To run the chrolog.so and chrolog-server build (build-lib-linux) .
or
Execute command -> Task: run task -> build-lib-linux

```bash
npm run m-postinstall
npm run build:linux
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"build:mac": " npm run build && electron-builder --mac --config",
"build:linux": " npm run build && electron-builder --linux --config",
"react-devtools": "react-devtools",
"test-lib": "cross-env NODE_PATH=./node_modules sudo node ./src/lib/test.js",
"test-lib": "cross-env NODE_PATH=./node_modules node ./src/lib/test.js",
"test-server": "node ./src/lib/chrolog-server/test-server.js"
},
"electronWebpack": {
Expand Down

0 comments on commit 3edaf7c

Please sign in to comment.