Skip to content

Commit 6884a16

Browse files
committed
Update NPM Release
1 parent 8b965ff commit 6884a16

5 files changed

Lines changed: 52 additions & 11 deletions

File tree

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ jobs:
156156
run: |
157157
unzip -n FileSystem-linux.zip
158158
unzip -n FileSystem-windows.zip
159-
rm FileSystem-*.zip
159+
rm -rfd FileSystem-*.zip .github FileSystem.cc README.md
160160
161161
- name: Publish to NPM
162162
if: env.release_exists == 'false'

.github/workflows/validate_pull.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ jobs:
1616
runs-on: windows-latest
1717
steps:
1818
- name: Setup Node.js
19-
uses: actions/setup-node@v4.0.4
19+
uses: actions/setup-node@v4
2020
with:
2121
node-version: 20
2222

2323
- name: Checkout Code
24-
uses: actions/checkout@v4.2.1
24+
uses: actions/checkout@v4
2525

2626
- name: Setup Visual Studio Environment
27-
uses: egor-tensin/vs-shell@v2.1
27+
uses: egor-tensin/vs-shell@v2
2828

2929
- name: Compile Library
30-
run: cl /O2 /std:c++17 /LD /Zi FileSystem.cc
30+
run: cl /O2 /std:c++17 /LD FileSystem.cc
3131

3232
- name: Test Node.js Module
3333
run: npm i
@@ -36,15 +36,15 @@ jobs:
3636
runs-on: ubuntu-latest
3737
steps:
3838
- name: Setup Node.js
39-
uses: actions/setup-node@v4.0.4
39+
uses: actions/setup-node@v4
4040
with:
4141
node-version: 20
4242

4343
- name: Checkout Code
44-
uses: actions/checkout@v4.2.1
44+
uses: actions/checkout@v4
4545

4646
- name: Compile Library
47-
run: g++ -O3 -g -fPIC -shared -o FileSystem.so FileSystem.cc
47+
run: g++ -O2 -fPIC -shared -o FileSystem.so FileSystem.cc
4848

4949
- name: Test Node.js Module
5050
run: npm i

.npmignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,42 @@
11
# The Linux File System in C++ for Linux/Windows
2+
## Library Install
3+
4+
### Windows
5+
You must have Visual Studio 2022 with the "Desktop Development with C++" component installed.
6+
7+
Once it is installed,
8+
Open "x64 Native Tools Command Prompt for VS 2022",
9+
And run the following command:
10+
11+
```
12+
cl /O2 /std:c++17 /LD /Zi FileSystem.cc
13+
```
14+
15+
This will make `FileSystem.dll` and `FileSystem.lib` for you to use with your applications.
16+
It will also make `FileSystem.pdb` for debugging the library.
17+
18+
If you wish to leave out debug info, Remove the `/Zi` flag.
19+
20+
### Linux
21+
You must have any compiler installed. For this example, I'll assume you have `g++` installed.
22+
23+
Once you have installed the compiler, Run the following command:
24+
25+
```
26+
g++ -O2 -g -fPIC -shared -o FileSystem.so FileSystem.cc
27+
```
28+
29+
This will make `FileSystem.so` for you to use with your applications.
30+
31+
If you wish to leave out debug info, Remove the `-g` flag.
32+
33+
## Node.js Install
34+
You must follow the [Library Install](#library-install) steps first
35+
before installing the Node.js Module.
36+
37+
Once you have completed the [Library Install](#library-install),
38+
Simply run the following command:
239

340
```
4-
npm i @daisydogs07/filesystem
41+
npm i
542
```

package.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
{
22
"name": "@daisydogs07/filesystem",
3-
"version": "5.2.8",
3+
"version": "5.2.9",
44
"os": ["linux", "win32"],
55
"cpu": ["x64"],
6+
"keywords": [
7+
"filesystem",
8+
"linux",
9+
"windows"
10+
],
611
"main": "./build/Release/module.node",
712
"types": "module.d.ts",
813
"author": "DaisyDogs07",

0 commit comments

Comments
 (0)